net.krotscheck.kangaroo.authz.admin.v1.resource

Class AbstractService

java.lang.Object

net.krotscheck.kangaroo.authz.admin.v1.resource.AbstractService

Direct Known Subclasses:

ApplicationService, AuthenticatorService, ClientRedirectService, ClientReferrerService, ClientService, OAuthTokenService, RoleScopeService, RoleService, ScopeService, UserIdentityService, UserService

public abstract class AbstractService
extends Object

Abstract implementation of our common services.

Author:

Michael Krotscheck

Constructor Summary

Constructors

Constructor and Description
AbstractService()

Method Summary

Modifier and Type	Method and Description
protected void	assertCanAccess(AbstractAuthzEntity entity, String requiredScope) This method tests whether a particular entity may be accessed.
protected void	assertCanAccessSubresource(AbstractAuthzEntity entity, String requiredParentScope) This method tests whether a particular subresource entity may be accessed.
protected javax.ws.rs.core.Response	executeQuery(Class<? extends AbstractEntity> klass, org.hibernate.search.FullTextQuery query, int offset, int limit) Execute a search query.
protected abstract String	getAccessScope() Return the scope required to access resources on this service.
protected Application	getAdminApplication() Retrieve the admin application database entry for the current running test.
protected abstract String	getAdminScope() Return the scope required to access ALL resources on this services.
org.apache.commons.configuration.Configuration	getConfig() Get the configuration.
protected User	getCurrentUser() Retrieve the current user for this request.
org.hibernate.search.FullTextSession	getFullTextSession() Get the full text search session.
org.glassfish.jersey.internal.inject.InjectionManager	getInjector() Retrieve the injector for this context.
org.hibernate.search.SearchFactory	getSearchFactory() Retrieve the search factory.
javax.ws.rs.core.SecurityContext	getSecurityContext() Get the security context.
org.hibernate.Session	getSession() Get the session.
javax.ws.rs.core.UriInfo	getUriInfo() Get the URI info for the current request.
protected <K extends AbstractAuthzEntity> K	requireEntityInput(Class<K> requestedType, K entity) Provided a type and an entity, requires the existence of this entity.
protected <K extends AbstractAuthzEntity> K	resolveEntityInput(Class<K> requestedType, BigInteger entityId) Provided a type and an id, attempts to resolve a fresh entity from the database session.
protected <K extends AbstractAuthzEntity> K	resolveEntityInput(Class<K> requestedType, K entity) Provided a type and an entity, attempts to resolve a fresh entity from the database session.
protected <T extends AbstractAuthzEntity> T	resolveFilterEntity(Class<T> roleClass, BigInteger entityId) Attempt to resolve the provided ID into the requested entity type.
protected User	resolveOwnershipFilter(BigInteger ownerId) Determine the appropriate owner on which we should be filtering.
void	setConfig(org.apache.commons.configuration.Configuration config) Set the request configuration.
void	setFullTextSession(org.hibernate.search.FullTextSession fullTextSession) Set the full text search session.
void	setInjector(org.glassfish.jersey.internal.inject.InjectionManager injector) Set (via injection, usually) the injector for this resource.
void	setSearchFactory(org.hibernate.search.SearchFactory searchFactory) Set an instance of the search factory.
void	setSecurityContext(javax.ws.rs.core.SecurityContext securityContext) Set a new security context.
void	setSession(org.hibernate.Session session) Set the session.
void	setUriInfo(javax.ws.rs.core.UriInfo uriInfo) Set the URI info instance for the current request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractService

public AbstractService()

Method Detail

getInjector

public final org.glassfish.jersey.internal.inject.InjectionManager getInjector()

Retrieve the injector for this context.

Returns:

The locator.

setInjector

public final void setInjector(org.glassfish.jersey.internal.inject.InjectionManager injector)

Set (via injection, usually) the injector for this resource.

Parameters:

injector - The injector.

getUriInfo

public final javax.ws.rs.core.UriInfo getUriInfo()

Get the URI info for the current request.

Returns:

The URIInfo instance.

setUriInfo

public final void setUriInfo(javax.ws.rs.core.UriInfo uriInfo)

Set the URI info instance for the current request.

Parameters:

uriInfo - The new URIInfo instance.

getSession

public final org.hibernate.Session getSession()

Get the session.

Returns:

The injected session.

setSession

public final void setSession(org.hibernate.Session session)

Set the session.

Parameters:

session - The session.

getSearchFactory

public final org.hibernate.search.SearchFactory getSearchFactory()

Retrieve the search factory.

Returns:

The injected search factory.

setSearchFactory

public final void setSearchFactory(org.hibernate.search.SearchFactory searchFactory)

Set an instance of the search factory.

Parameters:

searchFactory - The search factory.

getFullTextSession

public final org.hibernate.search.FullTextSession getFullTextSession()

Get the full text search session.

Returns:

The injected lucene session.

setFullTextSession

public final void setFullTextSession(org.hibernate.search.FullTextSession fullTextSession)

Set the full text search session.

Parameters:

fullTextSession - The FTSession.

getConfig

public final org.apache.commons.configuration.Configuration getConfig()

Get the configuration.

Returns:

A configuration!

setConfig

public final void setConfig(org.apache.commons.configuration.Configuration config)

Set the request configuration.

Parameters:

config - A request configuration.

getSecurityContext

public final javax.ws.rs.core.SecurityContext getSecurityContext()

Get the security context.

Returns:

The request security context.

setSecurityContext

public final void setSecurityContext(javax.ws.rs.core.SecurityContext securityContext)

Set a new security context.

Parameters:

securityContext - A new security context.

getCurrentUser

protected final User getCurrentUser()

Retrieve the current user for this request.

Returns:

The current user, or null if not set.

getAdminScope

protected abstract String getAdminScope()

Return the scope required to access ALL resources on this services.

Returns:

A string naming the scope.

getAccessScope

protected abstract String getAccessScope()

Return the scope required to access resources on this service.

Returns:

A string naming the scope.

getAdminApplication

protected final Application getAdminApplication()

Retrieve the admin application database entry for the current running test.

Returns:

The admin application, assuming it's been bootstrapped.

assertCanAccess

protected final void assertCanAccess(AbstractAuthzEntity entity,
                                     String requiredScope)

This method tests whether a particular entity may be accessed. This is the case if one of two conditions is true. The first is simple- if the user has the administration scope of ENTITYNAME_ADMIN, then they may access this entity. If they only have the ENTITYNAME scope, then they must also be the owner of this entity (the owner of the application to which this entity belongs.

Parameters:

entity - The entity to check.

requiredScope - The scope required to access this entity.

assertCanAccessSubresource

protected final void assertCanAccessSubresource(AbstractAuthzEntity entity,
                                                String requiredParentScope)

This method tests whether a particular subresource entity may be accessed. It defers most of its logic to assertCanAccess, except that it will rethrow NotFoundExceptions as BadRequestExceptions in the case where a user does not have permissions to see the parent resource.

Parameters:

entity - The entity to check.

requiredParentScope - The scope required to access the parent entity.

resolveOwnershipFilter

protected final User resolveOwnershipFilter(BigInteger ownerId)

Determine the appropriate owner on which we should be filtering.

Parameters:

ownerId - The passed-in owner id, could be null.

Returns:

A , or null, indicating a valid filter action.

resolveFilterEntity

protected final <T extends AbstractAuthzEntity> T resolveFilterEntity(Class<T> roleClass,
                                                                      BigInteger entityId)

Attempt to resolve the provided ID into the requested entity type.

Type Parameters:

T - The return type.

Parameters:

roleClass - The entity type to resolve.

entityId - The ID to resolve.

Returns:

The resolved entity, or an exception if it cannot be accessed.

executeQuery

protected final javax.ws.rs.core.Response executeQuery(Class<? extends AbstractEntity> klass,
                                                       org.hibernate.search.FullTextQuery query,
                                                       int offset,
                                                       int limit)

Execute a search query.

Parameters:

klass - The type to cast to.

query - The fulltext query to execute.

offset - The query offset.

limit - The query limit.

Returns:

A response with the return values of this type.

resolveEntityInput

protected final <K extends AbstractAuthzEntity> K resolveEntityInput(Class<K> requestedType,
                                                                     K entity)

Provided a type and an entity, attempts to resolve a fresh entity from the database session.

Type Parameters:

K - The type to return (same as type to resolve).

Parameters:

requestedType - The type to resolve.

entity - The entity.

Returns:

Null if provided entity is null, otherwise entity.

resolveEntityInput

protected final <K extends AbstractAuthzEntity> K resolveEntityInput(Class<K> requestedType,
                                                                     BigInteger entityId)

Provided a type and an id, attempts to resolve a fresh entity from the database session.

Type Parameters:

K - The type to return (same as type to resolve).

Parameters:

requestedType - The type to resolve.

entityId - The entity id.

Returns:

Null if provided entity is null, otherwise entity.

requireEntityInput

protected final <K extends AbstractAuthzEntity> K requireEntityInput(Class<K> requestedType,
                                                                     K entity)

Provided a type and an entity, requires the existence of this entity.

Type Parameters:

K - The type to return (same as type to resolve).

Parameters:

requestedType - The type to resolve.

entity - The entity.

Returns:

Null if provided entity is null, otherwise entity.