*** This interface provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.information.metadata
Interface AuthorizationBaseInterface

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

AuthorizationUtilInterface

All Known Implementing Classes:

AuthorizationUtil

@SASScope(value="ALL")
@BinaryCompatibilityOnly
public interface AuthorizationBaseInterface
extends java.rmi.Remote

AuthorizationBase provides authorization methods common to protected Object and ACT definition usage.

Method Summary

abstract void	commit() Commit Authorization Changes Any pending Authorization changes will be committed on the Server.
abstract void	discard() Discard Authorization Changes Any pending Authorization changes will be discarded on the Server.
abstract java.util.List<java.lang.String>	getApplicablePermissions() Obtains permissions applicable to the object according to its PublicType Note that for ACT definition the entire list of available permissions is returned
abstract AuthorizationInfoInterface	getAuthorizations(IdentityInterface identity, java.util.List<java.lang.String> permissions) Get authorizations for a single identity
abstract java.util.List<AuthorizationInfoInterface>	getAuthorizations(java.util.List<IdentityInterface> identities, java.util.List<java.lang.String> permissions) Get authorizations for multiple identities
abstract java.util.List<AuthorizationInfoInterface>	getAuthorizationsAll() Get all authorizations
abstract AuthorizationExplainedInfoInterface	getAuthorizationsExplained(IdentityInterface identity, java.util.List<java.lang.String> permissions) Get authorization sources explained for a single identity.
abstract java.util.List<AuthorizationExplainedInfoInterface>	getAuthorizationsExplained(java.util.List<IdentityInterface> identities, java.util.List<java.lang.String> permissions) Get authorization sources explained for a list of identities.
abstract java.util.List<AuthorizationExplainedInfoInterface>	getAuthorizationsExplainedAll() Get authorization sources explained for all identities and permissions.
abstract boolean	getCommitOnUpdate() Obtains Commit with Object Store boolean indicator
abstract java.util.List<com.sas.services.information.metadata.AuthorizationIdentityInfoInterface>	getIdentityInfo() Returns authorization identity info corresponding to permissions on an object
abstract void	setAuthorizations(IdentityInterface identity, java.util.List<PermissionInfoInterface> permissionInfoList) Set permission(s) for a single identity
abstract void	setAuthorizations(java.util.List<AuthorizationInfoInterface> authorizations) Set permissions for multiple identities
abstract void	setCommitOnUpdate(boolean commitWithStore) Set Commit with Object Store boolean indicator

Method Detail

getCommitOnUpdate

boolean getCommitOnUpdate()
                          throws ServiceException,
                                 java.rmi.RemoteException

Obtains Commit with Object Store boolean indicator

Returns:

boolean value indicating if TransactionContext is committed with ObjectStore update

Throws:

com.sas.metadata.remote.MdException

java.rmi.RemoteException - In the event of remote object failure.

ServiceException

setCommitOnUpdate

void setCommitOnUpdate(boolean commitWithStore)
                       throws ServiceException,
                              java.rmi.RemoteException

Set Commit with Object Store boolean indicator

Parameters:

boolean - value indicating if Authorization TransactionContext is committed with ObjectStore update

Throws:

com.sas.metadata.remote.MdException

java.rmi.RemoteException - In the event of remote object failure.

ServiceException

getApplicablePermissions

java.util.List<java.lang.String> getApplicablePermissions()
                                                          throws ServiceException,
                                                                 java.rmi.RemoteException

Obtains permissions applicable to the object according to its PublicType

Note that for ACT definition the entire list of available permissions is returned

Returns:

List List of Permission names

Throws:

ServiceException

java.rmi.RemoteException - In the event of remote object failure.

getIdentityInfo

java.util.List<com.sas.services.information.metadata.AuthorizationIdentityInfoInterface> getIdentityInfo()
                                                                                                         throws ServiceException,
                                                                                                                java.rmi.RemoteException

Returns authorization identity info corresponding to permissions on an object

Returns:

A List of AuthorizationIdentityInfoInterface objects

Throws:

ServiceException

java.rmi.RemoteException - In the event of remote object failure.

getAuthorizations

AuthorizationInfoInterface getAuthorizations(IdentityInterface identity,
                                             java.util.List<java.lang.String> permissions)
                                             throws ServiceException,
                                                    java.rmi.RemoteException

Get authorizations for a single identity

Parameters:

identity - An Identity object representing the User, Group, or Role for which permissions are sought. If null is specified then an empty List is returned.

permissions - A List of Strings containing the permission names for which authorizations are sought. If the List is null or empty, all applicable permissions for the object are returned.

Returns:

A AuthorizationInfoInterface object containing the resulting authorization settings for the Identity.

Throws:

java.lang.IllegalArgumentException - If the identity parameter reference is null

ServiceException

java.rmi.RemoteException - in the event of remote object failure.

getAuthorizations

java.util.List<AuthorizationInfoInterface> getAuthorizations(java.util.List<IdentityInterface> identities,
                                                             java.util.List<java.lang.String> permissions)
                                                             throws ServiceException,
                                                                    java.rmi.RemoteException

Get authorizations for multiple identities

Parameters:

identities - A List of Identity objects representing the Users, Groups, or Roles for which permissions are sought. If the List is null or empty, authorizations for all relevant identities are returned.

permissions - A List of Strings containing the permission names for which authorizations are sought. If the List is null or empty, all applicable permissions for the object are returned.

Returns:

List<AuthorizationInfoInterface> A List containing the resulting authorization info

Throws:

ServiceException

java.rmi.RemoteException - in the event of remote object failure.

getAuthorizationsAll

java.util.List<AuthorizationInfoInterface> getAuthorizationsAll()
                                                                throws ServiceException,
                                                                       java.rmi.RemoteException

Get all authorizations

Returns:

List<AuthorizationInfoInterface> A List containing the resulting authorization info

Throws:

ServiceException

java.rmi.RemoteException - in the event of remote object failure.

setAuthorizations

void setAuthorizations(IdentityInterface identity,
                       java.util.List<PermissionInfoInterface> permissionInfoList)
                       throws ServiceException,
                              java.rmi.RemoteException

Set permission(s) for a single identity

Parameters:

identity - The identity for which permissions are being set

permissionInfoList - A List of one or more PermissionInfoInterface objects defining the permission(s) to set.

Throws:

java.lang.IllegalArgumentException - If the identity parameter reference is null If the permissionInfoList parameter reference is null

ServiceException

java.rmi.RemoteException - In the event of remote object failure.

setAuthorizations

void setAuthorizations(java.util.List<AuthorizationInfoInterface> authorizations)
                       throws ServiceException,
                              java.rmi.RemoteException

Set permissions for multiple identities

Parameters:

authorizations - A List of AuthorizationInfoInterface instances where each represents a unique Identity and the permission(s) to be set for it.

Throws:

java.lang.IllegalArgumentException - If the authorizations List parameter reference is null

ServiceException

java.rmi.RemoteException - In the event of remote object failure.

getAuthorizationsExplained

AuthorizationExplainedInfoInterface getAuthorizationsExplained(IdentityInterface identity,
                                                               java.util.List<java.lang.String> permissions)
                                                               throws ServiceException,
                                                                      java.rmi.RemoteException

Get authorization sources explained for a single identity.

Parameters:

identity - An Identity object representing the User Group, or Role for which permissions are sought.

permissions - A List of Strings containing the permission names for which authorizations are sought. If the List is null or empty, all applicable permissions for the object are returned.

Returns:

List<PermissionExplainedInfoInterface> A List containing the resulting authorization explained info

Throws:

java.lang.IllegalArgumentException - If the identity parameter reference is null

ServiceException - If a service level error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getAuthorizationsExplained

java.util.List<AuthorizationExplainedInfoInterface> getAuthorizationsExplained(java.util.List<IdentityInterface> identities,
                                                                               java.util.List<java.lang.String> permissions)
                                                                               throws ServiceException,
                                                                                      java.rmi.RemoteException

Get authorization sources explained for a list of identities.

Parameters:

identities - A List of Identity objects representing the Users, Groups, or Roles for which authorizations are sought. If the List is null or empty, authorizations for all relevant identities are returned.

permissions - A List of Strings containing the permission names for which authorizations are sought. If the List is null or empty, all applicable permissions for the object are returned.

Returns:

List<PermissionExplainedInfoInterface> A List containing the resulting authorization explained info

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getAuthorizationsExplainedAll

java.util.List<AuthorizationExplainedInfoInterface> getAuthorizationsExplainedAll()
                                                                                  throws ServiceException,
                                                                                         java.rmi.RemoteException

Get authorization sources explained for all identities and permissions.

Returns:

List<PermissionExplainedInfoInterface> A List containing the resulting authorization explained info

Throws:

ServiceException - if a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

commit

void commit()
            throws ServiceException,
                   java.rmi.RemoteException

Commit Authorization Changes Any pending Authorization changes will be committed on the Server. Current Authorization state will be reset for the corresponding object.

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - In the event of a remote object failure.

discard

void discard()
             throws ServiceException,
                    java.rmi.RemoteException

Discard Authorization Changes Any pending Authorization changes will be discarded on the Server. Current Authorization state will be reset for the corresponding object.

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - In the event of a remote object failure.

*** This interface provides Binary Compatibility only, not Source Compatibility ***