Changeset 6015


Ignore:
Timestamp:
02/23/15 12:47:30 (9 years ago)
Author:
olhsha@mpi.nl
Message:

Javadoc are updated for DebugResource?.java

File:
1 edited

Legend:

Unmodified
Added
Removed

  • DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/rest/DebugResource.java

    r5892 r6015  
    4444
    4545/**
    46  *
     46 * The class is used only by "admin" and "developer" principals; these account types are set in "principal" table.
    4747 * @author olhsha
    4848 */
    … …  
    5353    public static final String developer = "developer";
    5454   
    55    
     55    /**
     56     *
     57     * @return an arbitrary UUID string.
     58     */
    5659    @GET
    5760    @Produces(MediaType.TEXT_PLAIN)
    5861    @Path("uuid")
    59     public String generateUUID() throws IOException {
     62    public String generateUUID(){
    6063       return (Helpers.generateUUID()).toString();
    6164    }
    62 
     65   
     66    /**
     67     *
     68     * @return An {@link AnnotationInfoList}-element containing the list of {@link AnnotationInfo} objects of ALL the annotations,
     69     * with the latest (youngest) annotation on the top.
     70     * @throws IOException if sending the error fails.
     71     */
    6372    @GET
    6473    @Produces(MediaType.TEXT_XML)
    … …  
    8291   
    8392   
    84 
     93    /**
     94     *
     95     * @param n # of strings.
     96     * @return the latest n strings of the dasish database log file.
     97     * @throws IOException if sending the error fails.
     98     */
    8599    @GET
    86100    @Produces(MediaType.TEXT_PLAIN)
    … …  
    102116    }
    103117
     118    /**
     119     *
     120     * @return the remote ID of the logged in user.
     121     */
    104122    @GET
    105123    @Produces(MediaType.TEXT_PLAIN)
    … …  
    110128    }
    111129
    112     /////
     130   /**
     131    *
     132    * @param n # of strings
     133    * @return the last n strings of the dasish server logger (non-SQL-request logs).
     134    * @throws IOException if sending the error fails.
     135    */
    113136    @GET
    114137    @Produces(MediaType.TEXT_PLAIN)
    … …  
    130153    }
    131154
    132     //////////////////////////////////
     155    /**
     156     *
     157     * @param principalId the external UUID of a principal whose account type must be updated,
     158     * @param account the new account type (admin, developer, user).
     159     * @return a message if the account has been updated or not.
     160     * @throws IOException if sending the error fails.
     161     */
    133162    @PUT
    134163    @Produces(MediaType.TEXT_XML)
    … …  
    157186    }
    158187   
    159     //////////////////////////////////
     188    /**
     189     *
     190     * @param resource a type of resource (annotation, target, cached representation, principal, notebook).
     191     * @param oldExternalId the old external UUID of the resource.
     192     * @param newExternalId the new UUID of the resource
     193     * @return the message if the "newExternalIdentifier" has replaced the "oldExternalIdentifier" or not,
     194     * @throws IOException is sending the error fails.
     195     */
    160196    @PUT
    161197    @Produces(MediaType.TEXT_XML)
Note: See TracChangeset for help on using the changeset viewer.