org.ow2.proactive_grid_cloud_portal.common

Interface CommonRestInterface

@Path(value="/common")
 @Produces(value="application/json")
public interface CommonRestInterface

Method Summary

Modifier and Type	Method and Description
Map<String,Collection<String>>	addOrEditTenant(String sessionId, String tenant, Collection<String> groups) Add or Edit a tenant
boolean	checkPcaAdmin(String sessionId) Check if a user has admin privilege in cloud automation service.
Map<String,Boolean>	checkPermissions(String sessionId, List<String> methods) Check multiple methods permission.
Map<String,Boolean>	checkRolePermissions(String sessionId, List<String> roles) Check multiple service role permission.
boolean	checkSubscriptionAdmin(String sessionId) Check if a user has admin privilege in notification service.
List<OutputUserInfo>	createUser(String sessionId, InputUserInfo userInfo) Create user
String	currentUser(String sessionId) Get the login string associated to a session.
UserData	currentUserData(String sessionId) Get a UserData object associated to a session.
List<OutputUserInfo>	deleteUser(String sessionId, String username) Delete user
List<OutputUserInfo>	editUser(String sessionId, String username, InputUserInfo userInfo) Edit user
Set<String>	generateTokens(String sessionId, int numberTokens) Generate tokens which can be used as one-time access session identifiers
Map<String,String>	getCurrentLoggers(String sessionId) Get the state of current loggers.
String	getLogLevel(String sessionId, String name) Get logger level.
OutputUserInfo	getUserDetails(String sessionId, String username) Get user details
boolean	isConnected(String sessionId) Tests whether the session is connected to the ProActive server.
Map<String,Collection<String>>	listTenants(String sessionId) List tenants association
List<OutputUserInfo>	listUsers(String sessionId) List users
String	login(String username, String password) login to the server with username and password form.
String	loginWithCredential(LoginForm multipart) Login to the server using a multipart form.
void	logout(String sessionId) Terminates a session.
JAASConfiguration	permissionManagerGroupsRead(String sessionId) Read existing groups roles If the user has the RoleReaderPermission, it will return the roles of the current user's groups If the user has the RoleAdminPermission, it will return all existing group roles If the user does not have either of these permissions, it will return an error
JAASConfiguration	permissionManagerGroupsWrite(String sessionId, JAASConfiguration configuration) Write groups roles If the user has the RoleAdminPermission, new roles will be written and loaded on the server If the user does not have this permission, it will return an error
boolean	portalAccess(String sessionId, String portal) Check single portal access.
List<String>	portalsAccesses(String sessionId, List<String> portals) Check multiple portals accesses.
Map<String,Collection<String>>	removeTenant(String sessionId, String tenant) Delete a tenant
boolean	setLogLevel(String sessionId, String name, String level) Change logger level.
boolean	setLogLevelMultiple(String sessionId, Map<String,String> loggersConfiguration) Change multiple loggers level.

Method Detail

login

@POST
 @Path(value="login")
 @Produces(value={"text/plain","application/json"})
String login(@FormParam(value="username")
                                                                                             String username,
                                                                                             @FormParam(value="password")
                                                                                             String password)
                                                                                      throws LoginException,
                                                                                             SchedulerRestException

login to the server with username and password form.

Parameters:

username - username

password - password

Returns:

the session id associated to this new connection

Throws:

LoginException - if the authentication fails

SchedulerRestException - if any other error occurs

loginWithCredential

@POST
 @Consumes(value="multipart/form-data")
 @Path(value="login")
 @Produces(value={"text/plain","application/json"})
String loginWithCredential(LoginForm multipart)
                                                                                                                                            throws KeyException,
                                                                                                                                                   LoginException,
                                                                                                                                                   SchedulerRestException

Login to the server using a multipart form. It can be used either by submitting:

• 2 fields: 'username' and 'password'
• a credential file with field name 'credential'

Parameters:

multipart - multipart form

Returns:

the session id associated to this new connection

Throws:

LoginException - if the authentication fails

KeyException - if the credentials file cannot be decrypted

SchedulerRestException - if any other error occurs

logout

@PUT
 @Path(value="logout")
void logout(@HeaderParam(value="sessionid")
                                        String sessionId)
                                 throws RestException

Terminates a session.

Parameters:

sessionId - id of the session to terminate

Throws:

RestException - if the server cannot be contacted

isConnected

@GET
 @Path(value="connected")
 @Produces(value="application/json")
boolean isConnected(@HeaderParam(value="sessionid")
                                                                                        String sessionId)

Tests whether the session is connected to the ProActive server.

Parameters:

sessionId - the session to test

Returns:

true if the session is connected to the ProActive server, false otherwise.

generateTokens

@POST
 @Path(value="tokens")
 @Produces(value="application/json")
Set<String> generateTokens(@HeaderParam(value="sessionid")
                                                                                             String sessionId,
                                                                                             @QueryParam(value="numberTokens") @DefaultValue(value="1")
                                                                                             int numberTokens)

Generate tokens which can be used as one-time access session identifiers

Parameters:

sessionId - id of a session (tokens will be associated with this session)

numberTokens - number of tokens to generate

Returns:

a set of one-time access tokens

currentUser

@GET
 @Path(value="currentuser")
 @Produces(value="text/plain")
String currentUser(@HeaderParam(value="sessionid")
                                                                                   String sessionId)

Get the login string associated to a session.
NOTE:
In case the given sessionId doesn't have an associated login (session id expired, or invalid), this endpoint will return null

Parameters:

sessionId - id of a session

Returns:

the associated login value or an empty string

currentUserData

@GET
 @Path(value="currentuserdata")
 @Produces(value="application/json")
UserData currentUserData(@HeaderParam(value="sessionid")
                                                                                                   String sessionId)

Get a UserData object associated to a session.
NOTE:
In case the given sessionId doesn't have an associated login (session id expired, or invalid), this endpoint will return null

Parameters:

sessionId - id of a session

Returns:

a UserData object or null

portalsAccesses

@GET
 @Path(value="permissions/portals")
 @Produces(value="application/json")
List<String> portalsAccesses(@HeaderParam(value="sessionid")
                                                                                                           String sessionId,
                                                                                                           @QueryParam(value="portals")
                                                                                                           List<String> portals)
                                                                                                    throws RestException

Check multiple portals accesses. Test if a user has access to the portals specified.

Parameters:

sessionId - id of a session

portals - a list of portals access to test

Returns:

a sublist of accessible portals

Throws:

RestException - if an error occurs or the session is invalid

portalAccess

@GET
 @Path(value="permissions/portals/{portal}")
 @Produces(value="application/json")
boolean portalAccess(@HeaderParam(value="sessionid")
                                                                                                            String sessionId,
                                                                                                            @PathParam(value="portal")
                                                                                                            String portal)
                                                                                                     throws RestException

Check single portal access. Test if a user has access to the specified portal.

Parameters:

sessionId - id of a session

portal - string value identifying the portal

Returns:

true if the user can access the portal, false otherwise

Throws:

RestException - if an error occurs or the session is invalid

permissionManagerGroupsRead

@GET
 @Path(value="manager/groups")
 @Produces(value="application/json")
JAASConfiguration permissionManagerGroupsRead(@HeaderParam(value="sessionid")
                                                                                                                       String sessionId)
                                                                                                                throws RestException,
                                                                                                                       IOException

Read existing groups roles If the user has the RoleReaderPermission, it will return the roles of the current user's groups If the user has the RoleAdminPermission, it will return all existing group roles If the user does not have either of these permissions, it will return an error

Parameters:

sessionId - id of a session

Returns:

a structure containing the definition of group permissions

Throws:

RestException - if an error occurs or the session is invalid

IOException

permissionManagerGroupsWrite

@PUT
 @Path(value="manager/groups")
 @Produces(value="application/json")
JAASConfiguration permissionManagerGroupsWrite(@HeaderParam(value="sessionid")
                                                                                                                        String sessionId,
                                                                                                                        JAASConfiguration configuration)
                                                                                                                 throws RestException,
                                                                                                                        IOException

Write groups roles If the user has the RoleAdminPermission, new roles will be written and loaded on the server If the user does not have this permission, it will return an error

Parameters:

sessionId - id of a session

configuration - the new role configuration

Returns:

the new roles configuration

Throws:

RestException - if an error occurs or the session is invalid

IOException

checkSubscriptionAdmin

@GET
 @Path(value="permissions/notification-service/admin")
 @Produces(value="application/json")
boolean checkSubscriptionAdmin(@HeaderParam(value="sessionid")
                                                                                                                                String sessionId)
                                                                                                                         throws RestException

Check if a user has admin privilege in notification service.

Parameters:

sessionId - id of a session

Returns:

true if the user has the correct rights

Throws:

RestException - if an error occurs or the session is invalid

checkPcaAdmin

@GET
 @Path(value="permissions/cloud-automation-service/admin")
 @Produces(value="application/json")
boolean checkPcaAdmin(@HeaderParam(value="sessionid")
                                                                                                                           String sessionId)
                                                                                                                    throws RestException

Check if a user has admin privilege in cloud automation service.

Parameters:

sessionId - id of a session

Returns:

true if the user has the correct rights

Throws:

RestException - if an error occurs or the session is invalid

getLogLevel

@GET
 @Path(value="logger")
 @Produces(value="application/json")
String getLogLevel(@HeaderParam(value="sessionid")
                                                                                    String sessionId,
                                                                                    @QueryParam(value="name")
                                                                                    String name)
                                                                             throws RestException

Get logger level.

Parameters:

sessionId - id of a session

name - logger name

Returns:

logger level

Throws:

RestException - if an error occurs or the session is invalid

setLogLevel

@PUT
 @Path(value="logger")
 @Produces(value="application/json")
boolean setLogLevel(@HeaderParam(value="sessionid")
                                                                                     String sessionId,
                                                                                     @QueryParam(value="name")
                                                                                     String name,
                                                                                     @QueryParam(value="level")
                                                                                     String level)
                                                                              throws RestException

Change logger level.

Parameters:

sessionId - id of a session

name - logger name

level - logger level

Returns:

true if the logger level has been changed, false otherwise

Throws:

RestException - if an error occurs or the session is invalid

setLogLevelMultiple

@POST
 @Path(value="logger")
 @Consumes(value="application/json")
 @Produces(value="application/json")
boolean setLogLevelMultiple(@HeaderParam(value="sessionid")
                                                                                                                                   String sessionId,
                                                                                                                                   Map<String,String> loggersConfiguration)
                                                                                                                            throws RestException

Change multiple loggers level.

Parameters:

sessionId - id of a session

loggersConfiguration - map of (logger_name, level)

Returns:

true if any logger level has been changed, false otherwise

Throws:

RestException - if an error occurs or the session is invalid

getCurrentLoggers

@GET
 @Path(value="logger/current")
 @Produces(value="application/json")
Map<String,String> getCurrentLoggers(@HeaderParam(value="sessionid")
                                                                                                              String sessionId)
                                                                                                       throws RestException

Get the state of current loggers.

Parameters:

sessionId - id of a session

Returns:

a map containing current loggers and their level

Throws:

RestException - if an error occurs or the session is invalid

checkPermissions

@POST
 @Path(value="permissions/methods")
 @Consumes(value="application/json")
 @Produces(value="application/json")
Map<String,Boolean> checkPermissions(@HeaderParam(value="sessionid")
                                                                                                                                                         String sessionId,
                                                                                                                                                         List<String> methods)
                                                                                                                                                  throws RestException

Check multiple methods permission. Test if a user has access to the specified methods.

Parameters:

sessionId - id of a session

methods - a list of methods to check

Returns:

a map containing the method and true/false if the user has permission

Throws:

RestException - if an error occurs or the session is invalid

checkRolePermissions

@POST
 @Path(value="permissions/roles")
 @Consumes(value="application/json")
 @Produces(value="application/json")
Map<String,Boolean> checkRolePermissions(@HeaderParam(value="sessionid")
                                                                                                                                                           String sessionId,
                                                                                                                                                           List<String> roles)
                                                                                                                                                    throws RestException

Check multiple service role permission. Test if a user has access to the specified service roles.

Parameters:

sessionId - id of a session

roles - a list of service roles to check

Returns:

a map containing the service role and true/false if the user has permission

Throws:

RestException - if an error occurs or the session is invalid

createUser

@POST
 @Path(value="manager/users")
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<OutputUserInfo> createUser(@HeaderParam(value="sessionid")
                                                                                                                                              String sessionId,
                                                                                                                                              InputUserInfo userInfo)
                                                                                                                                       throws NotConnectedRestException,
                                                                                                                                              PermissionRestException,
                                                                                                                                              LoginRestException

Create user

Parameters:

sessionId - id of a session

userInfo - new account details

Returns:

the list of internal users after adding the user

Throws:

NotConnectedRestException

PermissionRestException

LoginRestException

listUsers

@GET
 @Path(value="manager/users")
 @Produces(value="application/json")
List<OutputUserInfo> listUsers(@HeaderParam(value="sessionid")
                                                                                                       String sessionId)
                                                                                                throws NotConnectedRestException,
                                                                                                       PermissionRestException,
                                                                                                       LoginRestException

List users

Parameters:

sessionId - id of a session

Returns:

the list of internal users

Throws:

NotConnectedRestException

PermissionRestException

LoginRestException

getUserDetails

@GET
 @Path(value="manager/users/{username}")
 @Produces(value="application/json")
OutputUserInfo getUserDetails(@HeaderParam(value="sessionid")
                                                                                                                 String sessionId,
                                                                                                                 @PathParam(value="username")
                                                                                                                 String username)
                                                                                                          throws NotConnectedRestException,
                                                                                                                 PermissionRestException,
                                                                                                                 LoginRestException

Get user details

Parameters:

sessionId - id of a session

username - username of the user

Returns:

a single user details

Throws:

NotConnectedRestException

PermissionRestException

LoginRestException

editUser

@PUT
 @Path(value="manager/users/{username}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<OutputUserInfo> editUser(@HeaderParam(value="sessionid")
                                                                                                                                                      String sessionId,
                                                                                                                                                      @PathParam(value="username")
                                                                                                                                                      String username,
                                                                                                                                                      InputUserInfo userInfo)
                                                                                                                                               throws NotConnectedRestException,
                                                                                                                                                      PermissionRestException,
                                                                                                                                                      LoginRestException

Edit user

Parameters:

sessionId - id of a session

username - username of the user

userInfo - input modifications to the user

Returns:

the list of internal users after editing the user

Throws:

NotConnectedRestException

PermissionRestException

LoginRestException

deleteUser

@DELETE
 @Path(value="manager/users/{username}")
 @Produces(value="application/json")
List<OutputUserInfo> deleteUser(@HeaderParam(value="sessionid")
                                                                                                                      String sessionId,
                                                                                                                      @PathParam(value="username")
                                                                                                                      String username)
                                                                                                               throws NotConnectedRestException,
                                                                                                                      PermissionRestException,
                                                                                                                      LoginRestException

Delete user

Parameters:

sessionId - id of a session

username - username of the user

Returns:

the list of internal users after deleting the user

Throws:

NotConnectedRestException

PermissionRestException

LoginRestException

listTenants

@GET
 @Path(value="manager/tenants")
 @Produces(value="application/json")
Map<String,Collection<String>> listTenants(@HeaderParam(value="sessionid")
                                                                                                                     String sessionId)
                                                                                                              throws NotConnectedRestException,
                                                                                                                     PermissionRestException,
                                                                                                                     LoginRestException

List tenants association

Parameters:

sessionId - id of a session

Returns:

the tenants to group associations

Throws:

NotConnectedRestException

PermissionRestException

LoginRestException

addOrEditTenant

@PUT
 @Path(value="manager/tenants/{tenant}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
Map<String,Collection<String>> addOrEditTenant(@HeaderParam(value="sessionid")
                                                                                                                                                                       String sessionId,
                                                                                                                                                                       @PathParam(value="tenant")
                                                                                                                                                                       String tenant,
                                                                                                                                                                       Collection<String> groups)
                                                                                                                                                                throws NotConnectedRestException,
                                                                                                                                                                       PermissionRestException,
                                                                                                                                                                       LoginRestException

Add or Edit a tenant

Parameters:

sessionId - id of a session

tenant - tenant name

groups - set of groups to associate

Returns:

the tenants to group associations after modification

Throws:

NotConnectedRestException

PermissionRestException

LoginRestException

removeTenant

@DELETE
 @Path(value="manager/tenants/{tenant}")
 @Produces(value="application/json")
Map<String,Collection<String>> removeTenant(@HeaderParam(value="sessionid")
                                                                                                                                  String sessionId,
                                                                                                                                  @PathParam(value="tenant")
                                                                                                                                  String tenant)
                                                                                                                           throws NotConnectedRestException,
                                                                                                                                  PermissionRestException,
                                                                                                                                  LoginRestException

Delete a tenant

Parameters:

sessionId - id of a session

tenant - tenant name

Returns:

the tenants to group associations after modification

Throws:

NotConnectedRestException

PermissionRestException

LoginRestException