org.apache.jetspeed.sso.impl
Class SSOSiteImpl

java.lang.Object
  org.apache.jetspeed.sso.impl.SSOSiteImpl

All Implemented Interfaces:

SSOSite

public class SSOSiteImpl
extends java.lang.Object
implements SSOSite

SSOSiteImpl Class holding information about the Site and credentials for Single Sign on SSO. OJB will map the database entries into this class

Version:

$Id: SSOSiteImpl.java 516448 2007-03-09 16:25:47Z ate $

Author:

Roger Ruttimann

Constructor Summary

SSOSiteImpl()

Method Summary

void	addPrincipal(SSOPrincipal principal) addPrincipal Adds the SSOPrincipal to the principals collection
void	configFormAuthentication(java.lang.String formUserField, java.lang.String formPwdField) Form authentication requires two fields that hold the credential information for the request.
java.lang.String	getFormPwdField()
java.lang.String	getFormUserField()
java.lang.String	getName()
java.util.Collection	getPrincipals()
java.lang.String	getRealm()
java.util.Collection	getRemotePrincipals() getRemotePrincipals
int	getSiteId()
java.lang.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()
void	setChallengeResponseAuthentication(boolean isChallangeResponseAuthentication)
void	setFormAuthentication(boolean isFormAuthentication) Define the Authentication methods.
void	setFormAuthentication(java.lang.String formUserField, java.lang.String formPwdField) Form authentication requires two fields that hold the credential information for the request.
void	setFormPwdField(java.lang.String formPwdField)
void	setFormUserField(java.lang.String formUserField)
void	setName(java.lang.String name)
void	setPrincipals(java.util.Collection principals)
void	setRealm(java.lang.String realm)
void	setRemotePrincipals(java.util.Collection remotePrincipals) setRemotePrincipals
void	setSiteId(int siteId)
void	setSiteURL(java.lang.String siteURL)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SSOSiteImpl

public SSOSiteImpl()

Method Detail

isAllowUserSet

public boolean isAllowUserSet()

Specified by:

isAllowUserSet in interface SSOSite

Returns:

Returns the isAllowUserSet.

setAllowUserSet

public void setAllowUserSet(boolean isAllowUserSet)

Specified by:

setAllowUserSet in interface SSOSite

Parameters:

isAllowUserSet - The isAllowUserSet to set.

isCertificateRequired

public boolean isCertificateRequired()

Specified by:

isCertificateRequired in interface SSOSite

Returns:

Returns the isCertificateRequired.

setCertificateRequired

public void setCertificateRequired(boolean isCertificateRequired)

Specified by:

setCertificateRequired in interface SSOSite

Parameters:

isCertificateRequired - The isCertificateRequired to set.

getName

public java.lang.String getName()

Specified by:

getName in interface SSOSite

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

Specified by:

setName in interface SSOSite

Parameters:

name - The name to set.

getPrincipals

public java.util.Collection getPrincipals()

Specified by:

getPrincipals in interface SSOSite

Returns:

Returns the principals.

setPrincipals

public void setPrincipals(java.util.Collection principals)

Specified by:

setPrincipals in interface SSOSite

Parameters:

principals - The principals to set.

getSiteId

public int getSiteId()

Specified by:

getSiteId in interface SSOSite

Returns:

Returns the siteId.

setSiteId

public void setSiteId(int siteId)

Specified by:

setSiteId in interface SSOSite

Parameters:

siteId - The siteId to set.

getSiteURL

public java.lang.String getSiteURL()

Specified by:

getSiteURL in interface SSOSite

Returns:

Returns the siteURL.

setSiteURL

public void setSiteURL(java.lang.String siteURL)

Specified by:

setSiteURL in interface SSOSite

Parameters:

siteURL - The siteURL to set.

addPrincipal

public void addPrincipal(SSOPrincipal principal)
                  throws SSOException

addPrincipal Adds the SSOPrincipal to the principals collection

Specified by:

addPrincipal in interface SSOSite

Throws:

SSOException

removePrincipal

public void removePrincipal(long principalId)
                     throws SSOException

removePrincipal() removes a principal from the principals collection

Specified by:

removePrincipal in interface SSOSite

Throws:

SSOException

getRemotePrincipals

public java.util.Collection getRemotePrincipals()

Description copied from interface: SSOSite

getRemotePrincipals

Specified by:

getRemotePrincipals in interface SSOSite

Returns:

Returns the remotePrincipals.

setRemotePrincipals

public void setRemotePrincipals(java.util.Collection remotePrincipals)

Description copied from interface: SSOSite

setRemotePrincipals

Specified by:

setRemotePrincipals in interface SSOSite

Parameters:

remotePrincipals - The remotePrincipals to set.

setFormAuthentication

public void setFormAuthentication(java.lang.String formUserField,
                                  java.lang.String formPwdField)

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

setChallengeResponseAuthentication

public void setChallengeResponseAuthentication()

getFormPwdField

public java.lang.String getFormPwdField()

Specified by:

getFormPwdField in interface SSOSite

setFormPwdField

public void setFormPwdField(java.lang.String formPwdField)

Specified by:

setFormPwdField in interface SSOSite

getFormUserField

public java.lang.String getFormUserField()

Specified by:

getFormUserField in interface SSOSite

setFormUserField

public void setFormUserField(java.lang.String formUserField)

Specified by:

setFormUserField in interface SSOSite

isChallangeResponseAuthentication

public boolean isChallangeResponseAuthentication()

Specified by:

isChallangeResponseAuthentication in interface SSOSite

setChallengeResponseAuthentication

public void setChallengeResponseAuthentication(boolean isChallangeResponseAuthentication)

Specified by:

setChallengeResponseAuthentication in interface SSOSite

isFormAuthentication

public boolean isFormAuthentication()

Specified by:

isFormAuthentication in interface SSOSite

setFormAuthentication

public void setFormAuthentication(boolean isFormAuthentication)

Description copied from interface: SSOSite

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

Specified by:

setFormAuthentication in interface SSOSite

configFormAuthentication

public void configFormAuthentication(java.lang.String formUserField,
                                     java.lang.String formPwdField)

Description copied from interface: SSOSite

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

Specified by:

configFormAuthentication in interface SSOSite

setRealm

public void setRealm(java.lang.String realm)

Specified by:

setRealm in interface SSOSite

getRealm

public java.lang.String getRealm()

Specified by:

getRealm in interface SSOSite