Package org.silverpeas.core.admin.domain.model

Class Domain

java.lang.Object

org.silverpeas.core.admin.domain.model.Domain

All Implemented Interfaces:

Serializable, AuthDomain

public class Domain
extends Object
implements AuthDomain, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	MIXED_DOMAIN_ID

Fields inherited from interface org.silverpeas.core.security.authentication.AuthDomain

SILVERPEAS_DOMAIN_ID

Constructor Summary

Constructors

Constructor	Description
Domain()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getAuthenticationServer()	Gets the name of the authentication server used by this authentication domain.
String	getDescription()
String	getDriverClassName()	Gets the full class name of the domain driver that manages this domain.
String	getId()	Gets the unique identifier of the domain in Silverpeas.
List<String>	getLooks()
String	getName()	Gets the name of this authentication domain.
boolean	getProperty(String name, boolean defaultValue)
String	getPropFileName()	Gets the full name of the properties file that defines this domain.
org.silverpeas.kernel.bundle.SettingBundle	getSettings()
String	getSilverpeasServerURL()
Quota	getUserDomainQuota()
int	hashCode()
boolean	isMixedOne()
boolean	isQuotaReached()
void	setAuthenticationServer(String authenticationServer)	Sets the name of the authentication server that will perform the authentication process for this authentication domain.
void	setDescription(String description)
void	setDriverClassName(String className)	Sets the full class name of the domain driver that manages this domain.
void	setId(String id)
void	setName(String name)
void	setPropFileName(String propFileName)	Sets the full name of the properties file that defines this domain.
void	setSilverpeasServerURL(String silverpeasServerURL)
void	setUserDomainQuotaMaxCount(String userDomainQuotaMaxCount)	Sets the max count of users allowed for this domain.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.silverpeas.core.security.authentication.AuthDomain

getCredentialsChangePolicy

Field Detail

MIXED_DOMAIN_ID

public static final String MIXED_DOMAIN_ID

See Also:

Constant Field Values

Constructor Detail

Domain

public Domain()

Method Detail

getId

public String getId()

Description copied from interface: AuthDomain

Gets the unique identifier of the domain in Silverpeas. By convention, a default domain is defined for the users specifically created in Silverpeas itself: this domain has for identifier 0.

Specified by:

getId in interface AuthDomain

Returns:

the unique identifier of the domain in Silverpeas.

setId

public void setId(String id)

getName

public String getName()

Description copied from interface: AuthDomain

Gets the name of this authentication domain.

Specified by:

getName in interface AuthDomain

Returns:

its name.

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getDriverClassName

public String getDriverClassName()

Gets the full class name of the domain driver that manages this domain.

Returns:

the full path of the driver class.

setDriverClassName

public void setDriverClassName(String className)

Sets the full class name of the domain driver that manages this domain.

Parameters:

className - the full path of the driver class.

getPropFileName

public String getPropFileName()

Gets the full name of the properties file that defines this domain.

Returns:

the full path of the properties file defining this domain.

setPropFileName

public void setPropFileName(String propFileName)

Sets the full name of the properties file that defines this domain.

Parameters:

propFileName - the full path of the properties file defining this domain.

getAuthenticationServer

public String getAuthenticationServer()

Gets the name of the authentication server used by this authentication domain.

Returns:

the unique name of an authentication server.

setAuthenticationServer

public void setAuthenticationServer(String authenticationServer)

Sets the name of the authentication server that will perform the authentication process for this authentication domain.

Parameters:

authenticationServer - the class to be used.

getSilverpeasServerURL

public String getSilverpeasServerURL()

setSilverpeasServerURL

public void setSilverpeasServerURL(String silverpeasServerURL)

getUserDomainQuota

public Quota getUserDomainQuota()

Returns:

the userDomainQuota

setUserDomainQuotaMaxCount

public void setUserDomainQuotaMaxCount(String userDomainQuotaMaxCount)
                                throws QuotaException

Sets the max count of users allowed for this domain.

Parameters:

userDomainQuotaMaxCount - the quota about the maximum users allowed in this domain.

Throws:

QuotaException - if an error occurs while setting the quota.

isQuotaReached

public boolean isQuotaReached()

isMixedOne

public boolean isMixedOne()

getLooks

public List<String> getLooks()

getSettings

public org.silverpeas.kernel.bundle.SettingBundle getSettings()

getProperty

public boolean getProperty(String name,
                           boolean defaultValue)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object