org.cristalise.kernel.security

Class SecurityManager

java.lang.Object

org.cristalise.kernel.security.SecurityManager

public class SecurityManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecurityManager.BuiltInAction

Constructor Summary

Constructors

Constructor and Description
SecurityManager()

Method Summary

Modifier and Type	Method and Description
void	authenticate()
AgentProxy	authenticate(String agentName, String agentPassword, String resource)
AgentProxy	authenticate(String agentName, String agentPassword, String resource, boolean isClient)
AgentProxy	authenticate(String agentName, String agentPassword, String resource, boolean isClient, TransactionKey transactionKey)
boolean	checkPermissions(AgentPath agent, Activity act, ItemPath itemPath, TransactionKey transactionKey)
boolean	checkPermissions(AgentPath agent, SecurityManager.BuiltInAction builtInAction, ItemPath itemPath, TransactionKey transactionKey)
static String	decodePublicSecurityMessage(Throwable ex) Reads the message from the exception that can be show to the user.
static String	encodePublicSecurityMessage(String msg) Wraps the massage with specific tokens indicating the the exception has a message to the user.
org.apache.shiro.subject.Subject	getSubject(AgentPath agent)
org.apache.shiro.subject.Subject	getSubject(String principal)
void	setupShiro() Loads shiro.ini file from a file or from the classpath (default) TODO: replace the use of IniSecurityManagerFactory with shiro Environment initialization
boolean	shiroAuthenticate(String agentName, String agentPassword)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityManager

public SecurityManager()
                throws InvalidDataException

Throws:

InvalidDataException

Method Detail

authenticate

public void authenticate()
                  throws InvalidDataException,
                         ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

authenticate

public AgentProxy authenticate(String agentName,
                               String agentPassword,
                               String resource)
                        throws InvalidDataException,
                               ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

authenticate

public AgentProxy authenticate(String agentName,
                               String agentPassword,
                               String resource,
                               boolean isClient)
                        throws InvalidDataException,
                               ObjectNotFoundException

Parameters:

agentName -

agentPassword -

resource -

isClient -

Returns:

Throws:

InvalidDataException

ObjectNotFoundException

authenticate

public AgentProxy authenticate(String agentName,
                               String agentPassword,
                               String resource,
                               boolean isClient,
                               TransactionKey transactionKey)
                        throws InvalidDataException,
                               ObjectNotFoundException

Parameters:

agentName -

agentPassword -

resource -

isClient - ItemProxy should only be used in the client processes

Returns:

AgentProxy of the user or returns null isClient is true

Throws:

InvalidDataException

ObjectNotFoundException

getSubject

public org.apache.shiro.subject.Subject getSubject(AgentPath agent)

Parameters:

agent -

Returns:

getSubject

public org.apache.shiro.subject.Subject getSubject(String principal)

Parameters:

principal -

Returns:

setupShiro

public void setupShiro()

Loads shiro.ini file from a file or from the classpath (default) TODO: replace the use of IniSecurityManagerFactory with shiro Environment initialization

decodePublicSecurityMessage

public static String decodePublicSecurityMessage(Throwable ex)

Reads the message from the exception that can be show to the user.

Parameters:

ex - the exception to be processed

Returns:

returns the message or null if nothing was found

encodePublicSecurityMessage

public static String encodePublicSecurityMessage(String msg)

Wraps the massage with specific tokens indicating the the exception has a message to the user.

Parameters:

msg - the message to be wrapped

Returns:

the wrapped message

shiroAuthenticate

public boolean shiroAuthenticate(String agentName,
                                 String agentPassword)
                          throws InvalidDataException

Parameters:

agentName -

agentPassword -

Returns:

Throws:

InvalidDataException

checkPermissions

public boolean checkPermissions(AgentPath agent,
                                Activity act,
                                ItemPath itemPath,
                                TransactionKey transactionKey)
                         throws AccessRightsException,
                                ObjectNotFoundException

Parameters:

agent -

stepPath -

itemPath -

Returns:

Throws:

AccessRightsException

ObjectNotFoundException - Item was not found

checkPermissions

public boolean checkPermissions(AgentPath agent,
                                SecurityManager.BuiltInAction builtInAction,
                                ItemPath itemPath,
                                TransactionKey transactionKey)
                         throws AccessRightsException,
                                ObjectNotFoundException

Parameters:

agent -

stepPath -

itemPath -

Returns:

Throws:

AccessRightsException

ObjectNotFoundException - Item was not found