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

com.sas.services.security.login
Interface ServerPrincipalInterface

All Superinterfaces:

PFSPrincipalInterface,

All Known Subinterfaces:

OMIServerPrincipalInterface

All Known Implementing Classes:

ServerPrincipal

public interface ServerPrincipalInterface

extends PFSPrincipalInterface

Method Summary

String	getBase() Get the base used to look up the user in the repository once connected.
String	getDescription() Get the user's description.
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 user's description.
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 interface com.sas.services.security.login.PFSPrincipalInterface

isProcessed, setProcessed

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Method Detail

getDescription

public String getDescription()

Get the user's description. It gets set from the user's record in the metadata repository.

Returns:

The user's description.

setDescription

public void setDescription(String description)

Set the user's description. param description The description of the user identified by userId.

getUserId

public String getUserId()

Get the userId that was authenticated.

Returns:

The authenticated user ID.

setUserId

public void setUserId(String userid)

Set the User ID that was authenticated.

Parameters:

userid - The userid that was authenticated with the server.

getHost

public String getHost()

Get the host name the authentication server is running on.

Returns:

the host name.

setHost

public void setHost(String host)

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

Parameters:

host - The host name.

getPort

public int getPort()

Get the port number of the authentication server.

Returns:

The port number.

setPort

public void setPort(int port)

Set the port number the authentication server is running on.

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".

Returns:

The protocol name.

setProtocol

public void setProtocol(String protocol)

Set the protocol name used by the authentication process.

Parameters:

protocol - The protocol name.

getDomain

public String getDomain()

Get the authentication domain name the user was authenticated against.

Returns:

The authentication domain name.

setDomain

public void setDomain(String domain)

Set the authentication domain name the user was authenticated against.

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.

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.

Parameters:

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

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