com.neurosys.security.auth.domain

Interface Authorizable

All Known Subinterfaces:

ExternalAccess, ExternalAccessTransformer, ManagedAuthorizable

All Known Implementing Classes:

AbstractAuthorizableConfiguration, AuthorizableETLMeta, AuthorizableExportType, AuthorizableFacetMeta, AuthorizableMenuItem, AuthorizableObject, AuthorizableReporterMeta, AuthorizableSecurableService, AuthorizableTemplate, AuthorizableTransformer, AuthorizationModule, AuthorizedRollOverMenuItem, ContentQueryService, DynamicConfigService, ExternalAccessTransformerWrapper, Feature, FeatureForOrganization, JPAFeature, JPAFeatureForOrganization, JPAProductPackage, JPATier, Module, NavigationModule, NavQueryService, OrderQueryService, ProductPackage, ProductQueryService, SiteAuthorizableSecurableService, Tier, UserLookupService

public interface Authorizable

Defines any service, component that is directly capable of being Authorized.
Any API that returns Authorizable type, implies the level of access needed by the calling component to access it. The Calling component is free to define how it introspect's the current User to gain the Users set of Authorizations for this component.
For example User.getAuthorizationMap() the value is a Set of Authorization and the key should match that of the getAuthorizableId() of the Authorizable entity.

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
String	getAuthorizableId() Every Authorizable entity should specify its key/id so that the Calling API knows which Set of Authorizations to match with
Boolean	getAuthorizableIdAssignable() Is the getAuthorizableId() of this instance to be considered in the global list of Authorizations. If true, it will appear in the List of Authorizations that can be assigned to users.
Collection<Authorization>	getAuthorizations() Authorizations required to access the component
void	setAuthorizableId(String id)
void	setAuthorizations(Collection<Authorization> authorizations) Authorizations required to access the component

Method Detail

getAuthorizableId

String getAuthorizableId()

Every Authorizable entity should specify its key/id so that the Calling API knows which Set of Authorizations to match with

Returns:

String

setAuthorizableId

void setAuthorizableId(String id)

getAuthorizableIdAssignable

Boolean getAuthorizableIdAssignable()

Is the getAuthorizableId() of this instance to be considered in the global list of Authorizations.
If true, it will appear in the List of Authorizations that can be assigned to users. Null is implementation dependent

Returns:

Boolean @Nullable

getAuthorizations

Collection<Authorization> getAuthorizations()

Authorizations required to access the component

setAuthorizations

void setAuthorizations(Collection<Authorization> authorizations)

Authorizations required to access the component