*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.security.login
Class ServerPrincipal

java.lang.Object
  |
  +--com.sas.services.security.login.PFSPrincipal
        |
        +--com.sas.services.security.login.ServerPrincipal

All Implemented Interfaces:

PFSPrincipalInterface, ServerPrincipalInterface

Direct Known Subclasses:

OMIServerPrincipal

public class ServerPrincipal

extends PFSPrincipal

implements ServerPrincipalInterface

This class represents an authenticated principal identity which was authenticated against a repository server. The UserService uses the information in this object to re-establish a connection with the server and stored in the UserContext.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

ServerPrincipal(String name)
Create a new ServerPrincipal with the given name.

Method Summary

boolean	equals(Object o) Test another object for equality with this one.
String	getBase() Get the base used to look up the user in the repository once connected.
String	getDescription() Get the description for the user identified by userId.
String	getDomain() Get the authentication domain name the user was authenticated against.
String	getHost() Get the host name the authentication server is running on.
int	getPort() Get the port number of the authentication server.
String	getProtocol() Set the application protocol used by the authentication process.
String	getUserId() Get the userId that was authenticated.
void	setBase(String base) Set the base location where the authenticated user was found in the repository.
void	setDescription(String description) Set the description for the user identified by userId.
void	setDomain(String domain) Set the authentication domain name the user was authenticated against.
void	setHost(String host) Set the name of the host the authentication server is running on.
void	setPort(int port) Set the port number the authentication server is running on.
void	setProtocol(String protocol) Set the protocol name used by the authentication process.
void	setUserId(String userid) Set the User ID that was authenticated.

Methods inherited from class com.sas.services.security.login.PFSPrincipal

getName, hashCode, implies, isProcessed, setProcessed, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sas.services.security.login.PFSPrincipalInterface

isProcessed, setProcessed

Methods inherited from interface java.security.Principal

getName, hashCode, toString

Constructor Detail

ServerPrincipal

public ServerPrincipal(String name)

Create a new ServerPrincipal with the given name.

Method Detail

getDescription

public String getDescription()

Get the description for the user identified by userId.

Specified by:

getDescription in interface ServerPrincipalInterface

Following copied from interface: com.sas.services.security.login.ServerPrincipalInterface

Returns:

The user's description.

setDescription

public void setDescription(String description)

Set the description for the user identified by userId.

Specified by:

setDescription in interface ServerPrincipalInterface

getUserId

public String getUserId()

Get the userId that was authenticated.

Specified by:

getUserId in interface ServerPrincipalInterface

Returns:

The authenticated user ID.

setUserId

public void setUserId(String userid)

Set the User ID that was authenticated.

Specified by:

setUserId in interface ServerPrincipalInterface

Parameters:

userid - The userid that was authenticated with the server.

getHost

public String getHost()

Get the host name the authentication server is running on.

Specified by:

getHost in interface ServerPrincipalInterface

Returns:

the host name.

setHost

public void setHost(String host)

Set the name of the host the authentication server is running on.

Specified by:

setHost in interface ServerPrincipalInterface

Parameters:

host - The host name.

getPort

public int getPort()

Get the port number of the authentication server.

Specified by:

getPort in interface ServerPrincipalInterface

Returns:

The port number.

setPort

public void setPort(int port)

Set the port number the authentication server is running on.

Specified by:

setPort in interface ServerPrincipalInterface

Parameters:

port - The server port.

getProtocol

public String getProtocol()

Set the application protocol used by the authentication process. Currently, this will either likely be "ldap", "omi", or "dav".

Specified by:

getProtocol in interface ServerPrincipalInterface

Returns:

The protocol name.

setProtocol

public void setProtocol(String protocol)

Set the protocol name used by the authentication process.

Specified by:

setProtocol in interface ServerPrincipalInterface

Parameters:

protocol - The protocol name.

getDomain

public String getDomain()

Get the authentication domain name the user was authenticated against.

Specified by:

getDomain in interface ServerPrincipalInterface

Returns:

The authentication domain name.

setDomain

public void setDomain(String domain)

Set the authentication domain name the user was authenticated against.

Specified by:

setDomain in interface ServerPrincipalInterface

Parameters:

domain - The authentication domain name.

getBase

public String getBase()

Get the base used to look up the user in the repository once connected. The format of this base, or even its existence, may be repository-specific.

Specified by:

getBase in interface ServerPrincipalInterface

Returns:

The base location where the user was found.

setBase

public void setBase(String base)

Set the base location where the authenticated user was found in the repository.

Specified by:

setBase in interface ServerPrincipalInterface

Parameters:

base - The base location in the repository where the authenticated user was found.

equals

public boolean equals(Object o)

Description copied from class: PFSPrincipal

Test another object for equality with this one. An object is considered equal if it is a PFSPrincipal and the name equals the name of this one.

Specified by:

equals in interface Principal

Overrides:

equals in class PFSPrincipal

Following copied from class: com.sas.services.security.login.PFSPrincipal

Returns:

true if the other object is equal, false otherwise.

*** This API provides Binary Compatibility only, not Source Compatibility ***