org.apache.jetspeed.sso
Interface SSOSite

public interface SSOSite

Interface SSOSite

Author:

rruttimann

Method Summary

void	addPrincipal(SSOPrincipal principal) Adds the SSOPrincipal to the principals collection
void	configFormAuthentication(String formUserField, String formPwdField) Form authentication requires two fields that hold the credential information for the request.
String	getFormPwdField()
String	getFormUserField()
String	getName()
Collection	getPrincipals()
String	getRealm()
Collection	getRemotePrincipals() getRemotePrincipals
int	getSiteId()
String	getSiteURL()
boolean	isAllowUserSet()
boolean	isCertificateRequired()
boolean	isChallangeResponseAuthentication()
boolean	isFormAuthentication()
void	removePrincipal(long principalId) removePrincipal() removes a principal from the principals collection
void	setAllowUserSet(boolean isAllowUserSet)
void	setCertificateRequired(boolean isCertificateRequired)
void	setChallengeResponseAuthentication(boolean isChallengeResponseAuthentication)
void	setFormAuthentication(boolean isFormAuthentication) Define the Authentication methods.
void	setFormPwdField(String formPwdField)
void	setFormUserField(String formUserField)
void	setName(String name)
void	setPrincipals(Collection principals)
void	setRealm(String realm)
void	setRemotePrincipals(Collection remotePrincipals) setRemotePrincipals
void	setSiteId(int siteId)
void	setSiteURL(String siteURL)

Method Detail

isAllowUserSet

boolean isAllowUserSet()

Returns:

Returns the isAllowUserSet.

setAllowUserSet

void setAllowUserSet(boolean isAllowUserSet)

Parameters:

isAllowUserSet - The isAllowUserSet to set.

isCertificateRequired

boolean isCertificateRequired()

Returns:

Returns the isCertificateRequired.

setCertificateRequired

void setCertificateRequired(boolean isCertificateRequired)

Parameters:

isCertificateRequired - The isCertificateRequired to set.

getName

String getName()

Returns:

Returns the name.

setName

void setName(String name)

Parameters:

name - The name to set.

getPrincipals

Collection getPrincipals()

Returns:

Returns the principals.

setPrincipals

void setPrincipals(Collection principals)

Parameters:

principals - The principals to set.

getSiteId

int getSiteId()

Returns:

Returns the siteId.

setSiteId

void setSiteId(int siteId)

Parameters:

siteId - The siteId to set.

getSiteURL

String getSiteURL()

Returns:

Returns the siteURL.

setSiteURL

void setSiteURL(String siteURL)

Parameters:

siteURL - The siteURL to set.

addPrincipal

void addPrincipal(SSOPrincipal principal)
                  throws SSOException

Adds the SSOPrincipal to the principals collection

Throws:

SSOException

removePrincipal

void removePrincipal(long principalId)
                     throws SSOException

removePrincipal() removes a principal from the principals collection

Throws:

SSOException

getRemotePrincipals

Collection getRemotePrincipals()

getRemotePrincipals

setRemotePrincipals

void setRemotePrincipals(Collection remotePrincipals)

setRemotePrincipals

setFormAuthentication

void setFormAuthentication(boolean isFormAuthentication)

Define the Authentication methods. Supported are: Challenge Response and From based

configFormAuthentication

void configFormAuthentication(String formUserField,
                              String formPwdField)

Form authentication requires two fields that hold the credential information for the request.

setChallengeResponseAuthentication

void setChallengeResponseAuthentication(boolean isChallengeResponseAuthentication)

isChallangeResponseAuthentication

boolean isChallangeResponseAuthentication()

isFormAuthentication

boolean isFormAuthentication()

getFormPwdField

String getFormPwdField()

setFormPwdField

void setFormPwdField(String formPwdField)

getFormUserField

String getFormUserField()

setFormUserField

void setFormUserField(String formUserField)

setRealm

void setRealm(String realm)

getRealm

String getRealm()