g-Eclipse
Release 1.0.0

eu.geclipse.core.accesscontrol
Interface IACLActor


public interface IACLActor

An actor to be used in the ACL entries. An actor is granted or denied a given operation or role on a given resource, by means of an ACL.

Also known as 'target-subject' in the XACML standard.


Method Summary
 ActorType getActorType()
          Returns the ActorType of this actor.
 java.lang.String getCA()
          Gets the CA subject of this actor, if the type requires it.
 java.lang.String getID()
          Gets the actor's ID.
 ActorType[] getSupportedTypes()
          Queries the ActorTypes supported by this implementation.
 void setActorType(ActorType type)
          Sets the ActorType of this actor.
 void setCA(java.lang.String caName)
          Sets the CA subject of this actor, if the type requires it.
 void setID(java.lang.String actorId)
          Sets the actor's ID.
 

Method Detail

getSupportedTypes

ActorType[] getSupportedTypes()
Queries the ActorTypes supported by this implementation.

Returns:
an array of supported ActorTypes.

getActorType

ActorType getActorType()
Returns the ActorType of this actor.

Returns:
the ActorType.

setActorType

void setActorType(ActorType type)
                  throws ProblemException
Sets the ActorType of this actor.

Parameters:
type - the ActorType to set.
Throws:
ProblemException - if the type could not be set, for instance because the chosen type is not supported by this implementation.

getCA

java.lang.String getCA()
Gets the CA subject of this actor, if the type requires it.

Returns:
the issuer subject of this actor. Must return null if the type doesn't require an authority.

setCA

void setCA(java.lang.String caName)
           throws ProblemException
Sets the CA subject of this actor, if the type requires it.

Parameters:
caName - the CA subject to set.
Throws:
ProblemException - if the type doesn't require a CA, or if the argument is null but the type requires it

getID

java.lang.String getID()
Gets the actor's ID. Depending on the ActorType this means the X509's DN, a group name, or a SAML attribute in the format "attr_name=value".

Returns:
the actor's ID

setID

void setID(java.lang.String actorId)
           throws ProblemException
Sets the actor's ID. Depending on the ActorType this means the X509's DN, a group name, a user name, or a SAML attribute in the format "attr_name=value". Might also be a pattern.

Parameters:
actorId - the ID (resp. a pattern) to set for this actor.
Throws:
ProblemException - if the argument is null or invalid for the selected actor type.

g-Eclipse
Release 1.0.0