Package com.sun.identity.policy.plugins

Class WebServicesClients

java.lang.Object

com.sun.identity.policy.plugins.WebServicesClients

All Implemented Interfaces:

Subject, Cloneable

public class WebServicesClients
extends Object
implements Subject

This subject represents web services clients that authenticate to web service providers(PP service, Discovery Service) hosted by OpenAM. The clients authenticate either by Anonymous, X509 token, ClientTLS, or SAML token profile. This subject covers X509Token, ClientTLS and SAML Token profiles. The subject values are the subject DNs associated with the web services clients certificates.

Constructor Summary

Constructors

Constructor	Description
WebServicesClients()

Method Summary

Modifier and Type	Method	Description
Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getDisplayNameForValue(String value, Locale locale)	Returns the value as is like other subjects.
ValidValues	getValidValues(SSOToken token)	Returns certificate subject DNs in the KeyStore as possible values.
ValidValues	getValidValues(SSOToken token, String pattern)	Returns certificate subject DNs in the KeyStore as possible values.
Set	getValues()	Returns selected web services clients for this subject
Syntax	getValueSyntax(SSOToken token)	Returns the syntax of the subject type.
int	hashCode()	Return a hash code for this WebServicesClients.
void	initialize(Map configParams)	Initialize the subject.
boolean	isMember(SSOToken token)	Determines if the token belongs to the WebServicesClients object.
void	setValues(Set names)	Sets the selected web services clients for this subject.
void	WebServicesClients()	Default Constructor

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebServicesClients

public WebServicesClients()

Method Detail

WebServicesClients

public void WebServicesClients()

Default Constructor

initialize

public void initialize(Map configParams)

Initialize the subject. No properties are required for this subject.

Specified by:

initialize in interface Subject

Parameters:

configParams - configurational information

getValueSyntax

public Syntax getValueSyntax(SSOToken token)

Returns the syntax of the subject type.

Specified by:

getValueSyntax in interface Subject

Parameters:

token - the SSOToken.

Returns:

Syntax for this subject.

See Also:

Syntax

getValidValues

public ValidValues getValidValues(SSOToken token)
                           throws SSOException,
                                  PolicyException

Returns certificate subject DNs in the KeyStore as possible values.

Specified by:

getValidValues in interface Subject

Parameters:

token - the SSOToken

Returns:

ValidValues object wiht certificate subject DNs.

Throws:

SSOException - if SSO token is not valid

PolicyException - if unable to get the list of valid names.

getValidValues

public ValidValues getValidValues(SSOToken token,
                                  String pattern)
                           throws SSOException,
                                  PolicyException

Returns certificate subject DNs in the KeyStore as possible values.

Specified by:

getValidValues in interface Subject

Parameters:

token - the SSOToken

pattern - the pattern to match with valid values.

Returns:

ValidValues object wiht certificate subject DNs.

Throws:

SSOException - if SSO token is not valid

PolicyException - if unable to get the list of valid names.

getDisplayNameForValue

public String getDisplayNameForValue(String value,
                                     Locale locale)

Returns the value as is like other subjects.

Specified by:

getDisplayNameForValue in interface Subject

Parameters:

value - the input value

locale - the locale in which value should be returned.

Returns:

the display name for the value for the given locale.

getValues

public Set getValues()

Returns selected web services clients for this subject

Specified by:

getValues in interface Subject

Returns:

selected web services clients

setValues

public void setValues(Set names)
               throws InvalidNameException

Sets the selected web services clients for this subject.

Specified by:

setValues in interface Subject

Parameters:

names - the list of clients to set in the subject.

Throws:

InvalidNameException - if the given names are not valid

isMember

public boolean isMember(SSOToken token)
                 throws SSOException,
                        PolicyException

Determines if the token belongs to the WebServicesClients object.

Specified by:

isMember in interface Subject

Parameters:

token - SSOToken of the user

Returns:

true if the subject contains one of the web service client's certificate DNs(client ceritifcates, root CA certificate). false otherwise.

Throws:

SSOException - if SSO token is not valid

PolicyException - if an error occured while checking if the user is a member of this subject

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

o - another object that will be compared with this one

Returns:

true if equal; false otherwise.

clone

public Object clone()

Creates and returns a copy of this object.

Specified by:

clone in interface Subject

Overrides:

clone in class Object

Returns:

a copy of this object

hashCode

public int hashCode()

Return a hash code for this WebServicesClients.

Overrides:

hashCode in class Object

Returns:

a hash code for this WebServicesClients object.