Package org.rundeck.core.auth.access

Class BaseAuthorizingResource<T>

java.lang.Object

org.rundeck.core.auth.access.BaseAuthorizingAccess

org.rundeck.core.auth.access.BaseAuthorizingResource<T>

Type Parameters:

T - resource type

All Implemented Interfaces:

AuthorizingAccess, AuthorizingResource<T>

Direct Known Subclasses:

BaseAuthorizingIdResource

public abstract class BaseAuthorizingResource<T>
extends BaseAuthorizingAccess
implements AuthorizingResource<T>

Provides base implementation for authorized resource of a specific type without ID (singleton)

Constructor Summary

Constructors

Constructor	Description
BaseAuthorizingResource(com.dtolabs.rundeck.core.authorization.AuthContextProcessor rundeckAuthContextProcessor, javax.security.auth.Subject subject, NamedAuthProvider namedAuthActions)

Method Summary

Modifier and Type	Method	Description
T	access(AuthActions actions)	Access resource with required authorization
void	authorize(AuthActions actions)	Check authorization
protected abstract boolean	exists()
protected com.dtolabs.rundeck.core.authorization.AuthResource	getAuthResource()
protected abstract com.dtolabs.rundeck.core.authorization.AuthResource	getAuthResource(T resource)
T	getResource()	Access resource without authorization checks
protected abstract java.lang.String	getResourceIdent()
protected abstract java.lang.String	getResourceTypeName()
T	requireActions(AuthActions actions)
protected abstract java.util.Optional<T>	retrieve()

Methods inherited from class org.rundeck.core.auth.access.BaseAuthorizingAccess

authorizeNamed, getAuthContext, getNamedAuth, isAuthorized, isAuthorized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.rundeck.core.auth.access.AuthorizingAccess

authorizeNamed, getAuthContext, isAuthorized, isAuthorized

Constructor Detail

BaseAuthorizingResource

public BaseAuthorizingResource(com.dtolabs.rundeck.core.authorization.AuthContextProcessor rundeckAuthContextProcessor,
                               javax.security.auth.Subject subject,
                               NamedAuthProvider namedAuthActions)

Method Detail

getAuthResource

protected abstract com.dtolabs.rundeck.core.authorization.AuthResource getAuthResource(T resource)

Returns:

constructed authorization map for the resource

getResourceTypeName

protected abstract java.lang.String getResourceTypeName()

Specified by:

getResourceTypeName in class BaseAuthorizingAccess

Returns:

resource type name

getResourceIdent

protected abstract java.lang.String getResourceIdent()

Specified by:

getResourceIdent in class BaseAuthorizingAccess

Returns:

primary ID value

retrieve

protected abstract java.util.Optional<T> retrieve()

Returns:

resource or null if it does not exist

exists

protected abstract boolean exists()

Returns:

resource or null if it does not exist

access

public T access(AuthActions actions)
         throws UnauthorizedAccess,
                NotFound

Description copied from interface: AuthorizingResource

Access resource with required authorization

Specified by:

access in interface AuthorizingResource<T>

Parameters:

actions - auth actions

Throws:

UnauthorizedAccess - if unauthorized

NotFound - if not found

authorize

public void authorize(AuthActions actions)
               throws UnauthorizedAccess,
                      NotFound

Description copied from interface: AuthorizingAccess

Check authorization

Specified by:

authorize in interface AuthorizingAccess

Overrides:

authorize in class BaseAuthorizingAccess

Parameters:

actions - auth actions

Throws:

UnauthorizedAccess - if unauthorized

NotFound - if not found

getAuthResource

protected com.dtolabs.rundeck.core.authorization.AuthResource getAuthResource()
                                                                       throws NotFound

Specified by:

getAuthResource in class BaseAuthorizingAccess

Returns:

authorization resource map for the resource

Throws:

NotFound

requireActions

public T requireActions(AuthActions actions)
                 throws UnauthorizedAccess,
                        NotFound

Throws:

UnauthorizedAccess

NotFound

getResource

public T getResource()
              throws NotFound

Description copied from interface: AuthorizingResource

Access resource without authorization checks

Specified by:

getResource in interface AuthorizingResource<T>

Returns:

resource

Throws:

NotFound - if not found