com.soa.workflow.script

Interface Subject

public interface Subject

Represents the caller Subject in a workflow scripted environment.

You can gain access to an workflow action caller's subject as follows:

    subject = workflowContext.getCallerSubject();
 

From there you can get information about the subject using the same methods as com.soa.security.script.Subject

This class should properly overload the normal scripted Subject but that is not possible due to the way the constructors of that class are defined. Instead, this class delegates most of its methods to the underlying scripted Subject.

See Also:

com.soa.security.script.Subject

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Subject.PrincipalImpl

Method Summary

Modifier and Type	Method and Description
void	addPrivateCredential(java.lang.Object credential) Adds a private credential to the subject.
void	addPublicCredential(java.lang.Object credential) Adds a public credential to the subject.
BST	getBST(java.lang.String type) Returns the Binary Security Token (BST) public credential with the given type associated with the subject (if any).
java.security.cert.X509Certificate[]	getCertificateChain() Returns the chain of X.509 certificates associated with the Subject.
Name	getInputName() Returns the com.soa.security.script.Name public credential public credential associated with the subject (if any).
Principal[]	getPrincipals() Returns the list of principals associated with the Subject.
java.lang.Object[]	getPublicCredentials() Returns the list of public credentials associated with the Subject.
SAML1	getSAML1() Returns the com.soa.security.script.saml1.SAML1 public credential public credential associated with the subject (if any).
SAML2	getSAML2() Returns the com.soa.security.script.saml2.SAML2 public credential public credential associated with the subject (if any).
void	removePublicCredential(java.lang.Object credential) Removes a public credential from the subject.

Method Detail

getPrincipals

Principal[] getPrincipals()

Returns the list of principals associated with the Subject.

Returns:

List of Principals. Overload the normal scripted Subject method so users can determine the type of principals (class name) and access the native Principal methods to access type-specific information in the Principal. For examplem this is needed in order for workflow scripting to determine the caller identity in CM workflows

getPublicCredentials

java.lang.Object[] getPublicCredentials()

Returns the list of public credentials associated with the Subject. Changes to the list will not be reflected in the subject.

Returns:

List of credential Objects.

addPublicCredential

void addPublicCredential(java.lang.Object credential)

Adds a public credential to the subject.

Parameters:

credential - Credential to add (see com.soa.security.script.BST, X509Certificate, com.soa.security.script.Name, com.soa.security.script.saml1.SAML1, com.soa.security.script.saml2.SAML2)

addPrivateCredential

void addPrivateCredential(java.lang.Object credential)

Adds a private credential to the subject.

Parameters:

credential - Credential to add (see com.soa.security.script.Password

removePublicCredential

void removePublicCredential(java.lang.Object credential)

Removes a public credential from the subject.

Parameters:

credential - Credential to remove.

getCertificateChain

java.security.cert.X509Certificate[] getCertificateChain()

Returns the chain of X.509 certificates associated with the Subject. Changes to the list will not be reflected in the subject.

Returns:

X509Certificate[]

getBST

BST getBST(java.lang.String type)

Returns the Binary Security Token (BST) public credential with the given type associated with the subject (if any).

Parameters:

type - String URI representing the type of BST public credential to return.

Returns:

com.soa.security.script.BST of the given type, null if not present.

getInputName

Name getInputName()

Returns the com.soa.security.script.Name public credential public credential associated with the subject (if any). Note this credential is an unauthenticated name. To obtain the authenticated name of the subject use getPrincipals().

Returns:

Unauthenticated com.soa.security.script.Name public credential, null if not present.

getSAML1

SAML1 getSAML1()

Returns the com.soa.security.script.saml1.SAML1 public credential public credential associated with the subject (if any).

Returns:

com.soa.security.script.saml1.SAML1 public credential, null if not present.

getSAML2

SAML2 getSAML2()

Returns the com.soa.security.script.saml2.SAML2 public credential public credential associated with the subject (if any).

Returns:

com.soa.security.script.saml2.SAML2 public credential, null if not present.