@RolesAllowed(value="ROLE_tavernauser") public interface TavernaServerSecurityREST
Modifier and Type | Interface and Description |
---|---|
static class |
TavernaServerSecurityREST.CredentialHolder
A container for a credential, used to work around issues with type
inference in CXF's REST service handling and JAXB.
|
static class |
TavernaServerSecurityREST.CredentialList
A simple list of credential descriptions.
|
static class |
TavernaServerSecurityREST.Descriptor
A description of the security resources associated with a workflow run.
|
static interface |
TavernaServerSecurityREST.PathNames |
static class |
TavernaServerSecurityREST.PermissionDescription
An instruction to update the permissions for a user.
|
static class |
TavernaServerSecurityREST.PermissionsDescription
A description of the permissions granted to others by the owner of a
workflow run.
|
static class |
TavernaServerSecurityREST.TrustList
A simple list of trusted certificate descriptions.
|
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
addCredential(TavernaServerSecurityREST.CredentialHolder c,
javax.ws.rs.core.UriInfo ui)
Adds a new credential.
|
javax.ws.rs.core.Response |
addTrust(Trust t,
javax.ws.rs.core.UriInfo ui)
Adds a new trusted identity.
|
javax.ws.rs.core.Response |
credentialOptions(String id)
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
credentialsOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
deleteAllCredentials(javax.ws.rs.core.UriInfo ui)
Deletes all credentials associated with a run.
|
javax.ws.rs.core.Response |
deleteAllTrusts(javax.ws.rs.core.UriInfo ui)
Deletes all trusted identities associated with a run.
|
javax.ws.rs.core.Response |
deleteCredential(String id,
javax.ws.rs.core.UriInfo ui)
Deletes one credential associated with a run.
|
javax.ws.rs.core.Response |
deletePermission(String id,
javax.ws.rs.core.UriInfo ui)
Delete the permissions associated with a user, which restores them to the
default (no access unless they are the owner or have admin privileges).
|
javax.ws.rs.core.Response |
deleteTrust(String id,
javax.ws.rs.core.UriInfo ui)
Deletes one trusted identity associated with a run.
|
TavernaServerSecurityREST.Descriptor |
describe(javax.ws.rs.core.UriInfo ui)
Gets a description of the security information supported by the workflow
run.
|
Permission |
describePermission(String id)
Describe the particular permission granted to a user.
|
TavernaServerSecurityREST.PermissionsDescription |
describePermissions(javax.ws.rs.core.UriInfo ui) |
javax.ws.rs.core.Response |
descriptionOptions()
Get an outline of the operations supported.
|
String |
getOwner()
Gets the identity of who owns the workflow run.
|
TavernaServerSecurityREST.CredentialHolder |
getParticularCredential(String id)
Describe a particular credential.
|
Trust |
getParticularTrust(String id)
Describe a particular trusted identity.
|
TavernaServerSecurityREST.CredentialList |
listCredentials() |
TavernaServerSecurityREST.TrustList |
listTrusted() |
javax.ws.rs.core.Response |
makePermission(TavernaServerSecurityREST.PermissionDescription desc,
javax.ws.rs.core.UriInfo ui)
Manufacture a permission setting for a previously-unknown user.
|
javax.ws.rs.core.Response |
ownerOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
permissionOptions(String id)
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
permissionsOptions()
Get an outline of the operations supported.
|
TavernaServerSecurityREST.CredentialHolder |
setParticularCredential(String id,
TavernaServerSecurityREST.CredentialHolder c,
javax.ws.rs.core.UriInfo ui)
Update a particular credential.
|
Trust |
setParticularTrust(String id,
Trust t,
javax.ws.rs.core.UriInfo ui)
Update a particular trusted identity.
|
Permission |
setPermission(String id,
Permission perm)
Update the permission granted to a user.
|
javax.ws.rs.core.Response |
trustOptions(String id)
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
trustsOptions()
Get an outline of the operations supported.
|
@GET @Path(value="/") @Produces(value={"application/xml","application/json"}) @Nonnull TavernaServerSecurityREST.Descriptor describe(@Nonnull @Context javax.ws.rs.core.UriInfo ui)
ui
- About the URI used to access this resource.@OPTIONS @Path(value="/") javax.ws.rs.core.Response descriptionOptions()
@GET @Path(value="owner") @Produces(value="text/plain") @Nonnull String getOwner()
@OPTIONS @Path(value="owner") javax.ws.rs.core.Response ownerOptions()
@GET @Path(value="credentials") @Produces(value={"application/xml","application/json"}) @Nonnull TavernaServerSecurityREST.CredentialList listCredentials()
@OPTIONS @Path(value="credentials") javax.ws.rs.core.Response credentialsOptions()
@OPTIONS @Path(value="credentials/{id}") javax.ws.rs.core.Response credentialOptions(@PathParam(value="id") String id)
@GET @Path(value="credentials/{id}") @Produces(value={"application/xml","application/json"}) @Nonnull TavernaServerSecurityREST.CredentialHolder getParticularCredential(@Nonnull @PathParam(value="id") String id) throws NoCredentialException
id
- The id of the credential to fetch.NoCredentialException
- If the credential doesn't exist.@PUT @Path(value="credentials/{id}") @Consumes(value={"application/xml","application/json"}) @Produces(value={"application/xml","application/json"}) @Nonnull TavernaServerSecurityREST.CredentialHolder setParticularCredential(@Nonnull @PathParam(value="id") String id, @Nonnull TavernaServerSecurityREST.CredentialHolder c, @Nonnull @Context javax.ws.rs.core.UriInfo ui) throws InvalidCredentialException, BadStateChangeException
id
- The id of the credential to update.c
- The details of the credential to use in the update.ui
- Information about the URI used to access this resource.InvalidCredentialException
- If the credential description isn't valid.BadStateChangeException
- If the workflow run is not in the initialising state.@POST @Path(value="credentials") @Consumes(value={"application/xml","application/json"}) @Nonnull javax.ws.rs.core.Response addCredential(@Nonnull TavernaServerSecurityREST.CredentialHolder c, @Nonnull @Context javax.ws.rs.core.UriInfo ui) throws InvalidCredentialException, BadStateChangeException
c
- The details of the credential to create.ui
- Information about the URI used to access this resource.InvalidCredentialException
- If the credential description isn't valid.BadStateChangeException
- If the workflow run is not in the initialising state.@DELETE @Path(value="credentials") @Nonnull javax.ws.rs.core.Response deleteAllCredentials(@Nonnull @Context javax.ws.rs.core.UriInfo ui) throws BadStateChangeException
ui
- Information about the URI used to access this resource.BadStateChangeException
- If the workflow run is not in the initialising state.@DELETE @Path(value="credentials/{id}") @Nonnull javax.ws.rs.core.Response deleteCredential(@Nonnull @PathParam(value="id") String id, @Nonnull @Context javax.ws.rs.core.UriInfo ui) throws BadStateChangeException
id
- The identity of the credential to delete.ui
- Information about the URI used to access this resource.BadStateChangeException
- If the workflow run is not in the initialising state.@OPTIONS @Path(value="trusts") javax.ws.rs.core.Response trustsOptions()
@OPTIONS @Path(value="trusts/{id}") javax.ws.rs.core.Response trustOptions(@PathParam(value="id") String id)
@GET @Path(value="trusts") @Produces(value={"application/xml","application/json"}) @Nonnull TavernaServerSecurityREST.TrustList listTrusted()
@GET @Path(value="trusts/{id}") @Produces(value={"application/xml","application/json"}) @Nonnull Trust getParticularTrust(@Nonnull @PathParam(value="id") String id) throws NoCredentialException
id
- The id of the trusted identity to fetch.NoCredentialException
- If the trusted identity doesn't exist.@PUT @Path(value="trusts/{id}") @Consumes(value={"application/xml","application/json"}) @Produces(value={"application/xml","application/json"}) @Nonnull Trust setParticularTrust(@Nonnull @PathParam(value="id") String id, @Nonnull Trust t, @Nonnull @Context javax.ws.rs.core.UriInfo ui) throws InvalidCredentialException, BadStateChangeException
id
- The id of the trusted identity to update.t
- The details of the trusted identity to use in the update.ui
- Information about the URI used to access this resource.InvalidCredentialException
- If the trusted identity description isn't valid.BadStateChangeException
- If the workflow run is not in the initialising state.@POST @Path(value="trusts") @Consumes(value={"application/xml","application/json"}) @Nonnull javax.ws.rs.core.Response addTrust(@Nonnull Trust t, @Nonnull @Context javax.ws.rs.core.UriInfo ui) throws InvalidCredentialException, BadStateChangeException
t
- The details of the trusted identity to create.ui
- Information about the URI used to access this resource.InvalidCredentialException
- If the trusted identity description isn't valid.BadStateChangeException
- If the workflow run is not in the initialising state.@DELETE @Path(value="trusts") @Nonnull javax.ws.rs.core.Response deleteAllTrusts(@Nonnull @Context javax.ws.rs.core.UriInfo ui) throws BadStateChangeException
ui
- Information about the URI used to access this resource.BadStateChangeException
- If the workflow run is not in the initialising state.@DELETE @Path(value="trusts/{id}") @Nonnull javax.ws.rs.core.Response deleteTrust(@Nonnull @PathParam(value="id") String id, @Nonnull @Context javax.ws.rs.core.UriInfo ui) throws BadStateChangeException
id
- The identity of the trusted identity to delete.ui
- Information about the URI used to access this resource.BadStateChangeException
- If the workflow run is not in the initialising state.@OPTIONS @Path(value="permissions") javax.ws.rs.core.Response permissionsOptions()
@OPTIONS @Path(value="permissions/{id}") javax.ws.rs.core.Response permissionOptions(@PathParam(value="id") String id)
@GET @Path(value="permissions") @Produces(value={"application/xml","application/json"}) @Nonnull TavernaServerSecurityREST.PermissionsDescription describePermissions(@Nonnull @Context javax.ws.rs.core.UriInfo ui)
ui
- Information about the URI used to access this resource.@GET @Path(value="permissions/{id}") @Produces(value="text/plain") @Nonnull Permission describePermission(@Nonnull @PathParam(value="id") String id)
id
- The name of the user whose permissions are to be described.@PUT @Consumes(value="text/plain") @Produces(value="text/plain") @Path(value="permissions/{id}") @Nonnull Permission setPermission(@Nonnull @PathParam(value="id") String id, @Nonnull Permission perm)
id
- The name of the user whose permissions are to be updated. Note
that the owner always has full permissions.perm
- The permission level to set.@DELETE @Path(value="permissions/{id}") @Nonnull javax.ws.rs.core.Response deletePermission(@Nonnull @PathParam(value="id") String id, @Nonnull @Context javax.ws.rs.core.UriInfo ui)
id
- The name of the user whose permissions are to be revoked.ui
- Information about the URI used to access this resource.@POST @Path(value="permissions") @Consumes(value={"application/xml","application/json"}) @Nonnull javax.ws.rs.core.Response makePermission(@Nonnull TavernaServerSecurityREST.PermissionDescription desc, @Nonnull @Context javax.ws.rs.core.UriInfo ui)
desc
- A description of the name of the user and the permission level
to grant them.ui
- Information about the URI used to access this resource.Copyright © 2015–2018 The Apache Software Foundation. All rights reserved.