com.centrasite.resourceaccess.managers
Interface ResourceAccessManager

All Superinterfaces:
com.centrasite.jaxr.CentraSiteResourceAccessManager

public interface ResourceAccessManager
extends com.centrasite.jaxr.CentraSiteResourceAccessManager


Field Summary
static java.lang.String SYSTEM_JAAS_CONTEXT_PROPERTY
          System property to override the default JAAS context property (CentraSite).
 
Method Summary
 void close()
          Close the underlying connections if need be.
 javax.security.auth.Subject getAuthenticatedSubject()
          Get the authenticated (populated with principals) subject.
 com.centrasite.jaxr.CentraSiteConnection getConnection()
          Get instance of JAXR Connection.
 CentraSiteUser getCurrentUser()
          Get the currently logged-in user.
 ExternalRepositoryManager getExternalRepositoryManager()
          Get instance of ExternalRepositoryManager.
 GroupManager getGroupManager()
          Get instance of GroupManager.
 Importer getImporter()
          Get instance of Importer.
 PermissionManager getPermissionManager()
          Get instance of PermissionManager.
 java.lang.String getRepositoryType()
          Returns type of the external repository being currently used.
 RoleManager getRoleManager()
          Get instance of RoleManager.
 com.softwareag.security.jaas.interfaces.ITokenManager getTokenManagerExternal()
          Get the ITokenManager of the first SagUserPrincipal instance
 UserManager getUserManager()
          Get instance of UserManager.
 void open()
          Open the underlying connections if need be.
 
Methods inherited from interface com.centrasite.jaxr.CentraSiteResourceAccessManager
shutdown
 

Field Detail

SYSTEM_JAAS_CONTEXT_PROPERTY

static final java.lang.String SYSTEM_JAAS_CONTEXT_PROPERTY
System property to override the default JAAS context property (CentraSite).

See Also:
Constant Field Values
Method Detail

getConnection

com.centrasite.jaxr.CentraSiteConnection getConnection()
Get instance of JAXR Connection. The underlying JAXR Connection is returned. This is the connection that was originally passed in or created internally. It is needed to create JAXR types (for example InternationalString) that the API requires. Only a single instance per ResourceAccessManager.


getRoleManager

RoleManager getRoleManager()
                           throws javax.xml.registry.JAXRException,
                                  com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get instance of RoleManager. Only a single instance per ResourceAccessManager.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs
java.lang.IllegalStateException - if this RAM instance is not yet opened i.e. open() called.

getUserManager

UserManager getUserManager()
                           throws javax.xml.registry.JAXRException,
                                  com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get instance of UserManager. Only a single instance per ResourceAccessManager.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs
java.lang.IllegalStateException - if this RAM instance is not yet opened i.e. open() called.

getGroupManager

GroupManager getGroupManager()
                             throws javax.xml.registry.JAXRException,
                                    com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get instance of GroupManager. Only a single instance per ResourceAccessManager.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs
java.lang.IllegalStateException - if this RAM instance is not yet opened i.e. open() called.

getPermissionManager

PermissionManager getPermissionManager()
                                       throws javax.xml.registry.JAXRException,
                                              com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get instance of PermissionManager. Only a single instance per ResourceAccessManager.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs
java.lang.IllegalStateException - if this RAM instance is not yet opened i.e. open() called.

getTokenManagerExternal

com.softwareag.security.jaas.interfaces.ITokenManager getTokenManagerExternal()
                                                                              throws javax.xml.registry.JAXRException,
                                                                                     com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get the ITokenManager of the first SagUserPrincipal instance

Returns:
ITokenManager The ITokenManager of the first SagUserPrincipal instance taken from the authenticated subject principals or null if there aren't any.
Throws:
javax.xml.registry.JAXRException
com.softwareag.security.jaas.principals.SagGeneralSecurityException

getExternalRepositoryManager

ExternalRepositoryManager getExternalRepositoryManager()
                                                       throws javax.xml.registry.JAXRException,
                                                              com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get instance of ExternalRepositoryManager. Only a single instance per ResourceAccessManager.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs
java.lang.IllegalStateException - if this RAM instance is not yet opened i.e. open() called.

getImporter

Importer getImporter()
                     throws javax.xml.registry.JAXRException,
                            com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get instance of Importer. Only a single instance per ResourceAccessManager.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

getCurrentUser

CentraSiteUser getCurrentUser()
Get the currently logged-in user.

Returns:
CentraSiteUser instance.
Throws:
java.lang.IllegalStateException - if this RAM instance is not yet opened i.e. open() called.

open

void open()
          throws javax.xml.registry.JAXRException,
                 com.softwareag.security.jaas.principals.SagGeneralSecurityException,
                 javax.security.auth.login.LoginException,
                 java.io.IOException
Open the underlying connections if need be. Any other necessary initialization is also performed.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs
java.io.IOException - if an input/output error occurs
javax.security.auth.login.LoginException

close

void close()
           throws javax.xml.registry.JAXRException,
                  com.softwareag.security.jaas.principals.SagGeneralSecurityException,
                  javax.security.auth.login.LoginException
Close the underlying connections if need be. Any other necessary cleanup is also performed.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs
javax.security.auth.login.LoginException

getAuthenticatedSubject

javax.security.auth.Subject getAuthenticatedSubject()
Get the authenticated (populated with principals) subject.

Returns:
JAAS Subject.

getRepositoryType

java.lang.String getRepositoryType()
                                   throws com.softwareag.security.jaas.principals.SagGeneralSecurityException
Returns type of the external repository being currently used. NOTE: Until IUserRepositoryManager provides implelementation, this is just a dummy method that will alywas return "OS".

Returns:
repository type
Throws:
com.softwareag.security.jaas.principals.SagGeneralSecurityException - in case of error
java.lang.IllegalStateException - if this RAM instance is not yet opened i.e. open() called.