org.apache.jackrabbit.core.security
Interface JackrabbitSecurityManager

All Known Implementing Classes:
DefaultSecurityManager, SimpleSecurityManager, UserPerWorkspaceSecurityManager

public interface JackrabbitSecurityManager

JackrabbitSecurityManager...


Method Summary
 void close()
          Disposes this security manager instance and cleans all internal caches.
 void dispose(String workspaceName)
          Disposes those parts of this security manager that are related to the workspace indicated by the given workspaceName.
 AccessManager getAccessManager(Session session, AMContext amContext)
          Retrieve the AccessManager for the given session.
 AuthContext getAuthContext(Credentials creds, Subject subject, String workspaceName)
          Returns a new AuthContext for the specified credentials and subject.
 PrincipalManager getPrincipalManager(Session session)
          Retrieve the principal manager for the given session.
 String getUserID(Subject subject, String workspaceName)
          Retrieve the id to be displayed upon Session.getUserID() for the specified subject.
 UserManager getUserManager(Session session)
          Returns the user manager for the specified session.
 void init(Repository repository, Session systemSession)
           
 

Method Detail

init

void init(Repository repository,
          Session systemSession)
          throws RepositoryException
Throws:
RepositoryException

dispose

void dispose(String workspaceName)
Disposes those parts of this security manager that are related to the workspace indicated by the given workspaceName.

Parameters:
workspaceName - Name of the workspace that is being disposed.

close

void close()
Disposes this security manager instance and cleans all internal caches.


getAuthContext

AuthContext getAuthContext(Credentials creds,
                           Subject subject,
                           String workspaceName)
                           throws RepositoryException
Returns a new AuthContext for the specified credentials and subject.

Parameters:
creds -
subject -
workspaceName - The name of the workspace to login.
Returns:
A new AuthContext for the given creds and subject.
Throws:
RepositoryException

getAccessManager

AccessManager getAccessManager(Session session,
                               AMContext amContext)
                               throws RepositoryException
Retrieve the AccessManager for the given session.

Parameters:
session -
amContext -
Returns:
AccessManager for the specified session.
Throws:
RepositoryException

getPrincipalManager

PrincipalManager getPrincipalManager(Session session)
                                     throws RepositoryException
Retrieve the principal manager for the given session.

Parameters:
session -
Returns:
PrincipalManager for the given session.
Throws:
UnsupportedRepositoryOperationException - If principal management is not supported.
RepositoryException - if an error occurs

getUserManager

UserManager getUserManager(Session session)
                           throws RepositoryException
Returns the user manager for the specified session.

Parameters:
session -
Returns:
UserManager for the given session.
Throws:
UnsupportedRepositoryOperationException - If user management is not supported.
RepositoryException

getUserID

String getUserID(Subject subject,
                 String workspaceName)
                 throws RepositoryException
Retrieve the id to be displayed upon Session.getUserID() for the specified subject.

Parameters:
subject -
workspaceName -
Returns:
userID to be displayed upon Session.getUserID().
Throws:
RepositoryException


Copyright © 2004-2010 The Apache Software Foundation. All Rights Reserved.