com.openexchange.admin.rmi.dataobjects

Class Context

java.lang.Object

com.openexchange.admin.rmi.dataobjects.EnforceableDataObject

com.openexchange.admin.rmi.dataobjects.ExtendableDataObject

com.openexchange.admin.rmi.dataobjects.Context

All Implemented Interfaces:

NameAndIdObject, java.io.Serializable, java.lang.Cloneable

public class Context
extends ExtendableDataObject
implements NameAndIdObject

Class representing a context.

Author:

Manuel Kraft, Carsten Hoeger, Dennis Sieben

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Context()
Context(java.lang.Integer id)
Context(int id, java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLoginMapping(java.lang.String mapping)
void	addLoginMappings(java.util.Collection<java.lang.String> mapping)
boolean	equals(java.lang.Object obj)
java.lang.Long	getAverage_size()
java.lang.Boolean	getEnabled()
java.lang.String	getFilestore_name()
java.lang.Integer	getFilestoreId()
java.lang.Integer	getId() Returns the id of this object
java.lang.String	getIdAsString()
java.util.HashSet<java.lang.String>	getLoginMappings()
MaintenanceReason	getMaintenanceReason()
java.lang.String[]	getMandatoryMembersChange() At the moment no fields are defined here
java.lang.String[]	getMandatoryMembersCreate() At the moment setId(java.lang.Integer) and setMaxQuota(java.lang.Long) are defined here
java.lang.String[]	getMandatoryMembersDelete() At the moment no fields are defined here
java.lang.String[]	getMandatoryMembersRegister() At the moment no fields are defined here
java.lang.Long	getMaxQuota()
java.lang.String	getName() Returns the name of this object
java.util.Map<java.lang.String,java.lang.String>	getNamespace(java.lang.String namespace)
java.util.List<java.lang.Object[]>	getQuotas() Gets the quotas
Database	getReadDatabase()
java.lang.Long	getUsedQuota()
java.lang.String	getUserAttribute(java.lang.String namespace, java.lang.String name) Read a generic user attribute
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getUserAttributes()
Database	getWriteDatabase()
int	hashCode()
boolean	isAverage_sizeset()
java.lang.Boolean	isEnabled()
boolean	isEnabledset()
boolean	isFilestore_idset()
boolean	isFilestore_nameset()
boolean	isIdset()
boolean	isListrun() This settings are only used internally, don't manipulate the setting here or rely on this methods existence
boolean	isMaintenanceReasonset()
boolean	isMaxQuotaset()
boolean	isNameset()
boolean	isReadDatabaseset()
boolean	isUsedQuotaset()
boolean	isUserAttributesset() Used to check if the user attributes have been modified
boolean	isWriteDatabaseset()
boolean	removeLoginMapping(java.lang.String mapping)
boolean	removeLoginMappings(java.util.Collection<java.lang.String> mapping)
void	setAverage_size(java.lang.Long average_size) The context average size can only be configured in AdminDaemon.properties
void	setEnabled(java.lang.Boolean enabled)
void	setFilestore_name(java.lang.String filestore_name)
void	setFilestoreId(java.lang.Integer filestore_id)
void	setId(java.lang.Integer id) Sets the id for this object
void	setListrun(boolean listrun) This settings are only used internally, don't manipulate the setting here or rely on this methods existence
void	setLoginMappings(java.util.HashSet<java.lang.String> mappings)
void	setMaintenanceReason(MaintenanceReason maintenanceReason)
void	setMaxQuota(java.lang.Long maxQuota)
void	setName(java.lang.String name) Sets the name for this object
void	setQuotas(java.util.List<java.lang.Object[]> quotas) Sets the quotas
void	setReadDatabase(Database readDatabase)
void	setUsedQuota(java.lang.Long usedQuota)
void	setUserAttribute(java.lang.String namespace, java.lang.String name, java.lang.String value) Sets a generic user attribute
void	setUserAttributes(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> userAttributes)
void	setWriteDatabase(Database writeDatabase)
java.lang.String	toString()

Methods inherited from class com.openexchange.admin.rmi.dataobjects.ExtendableDataObject

addExtension, getAllExtensionsAsHash, getFirstExtensionByName, isExtensionsok, isExtensionsset, removeExtension, setExtensionsok

Methods inherited from class com.openexchange.admin.rmi.dataobjects.EnforceableDataObject

getUnsetMembers, mandatoryChangeMembersSet, mandatoryCreateMembersSet, mandatoryDeleteMembersSet, mandatoryRegisterMembersSet, testMandatoryCreateFieldsNull

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Context

public Context()

Context

public Context(java.lang.Integer id)

Parameters:

id -

Context

public Context(int id,
       java.lang.String name)

Parameters:

id -

name -

Method Detail

getId

public final java.lang.Integer getId()

Description copied from interface: NameAndIdObject

Returns the id of this object

Specified by:

getId in interface NameAndIdObject

Returns:

An Integer object containing the id

getIdAsString

public final java.lang.String getIdAsString()

setId

public final void setId(java.lang.Integer id)

Description copied from interface: NameAndIdObject

Sets the id for this object

Specified by:

setId in interface NameAndIdObject

Parameters:

id - An Integer object containing the id

getName

public final java.lang.String getName()

Description copied from interface: NameAndIdObject

Returns the name of this object

Specified by:

getName in interface NameAndIdObject

Returns:

A String containing the name

setName

public final void setName(java.lang.String name)

Description copied from interface: NameAndIdObject

Sets the name for this object

Specified by:

setName in interface NameAndIdObject

Parameters:

name - A String containing the name

setLoginMappings

public final void setLoginMappings(java.util.HashSet<java.lang.String> mappings)

addLoginMapping

public final void addLoginMapping(java.lang.String mapping)

addLoginMappings

public final void addLoginMappings(java.util.Collection<java.lang.String> mapping)

removeLoginMapping

public final boolean removeLoginMapping(java.lang.String mapping)

removeLoginMappings

public final boolean removeLoginMappings(java.util.Collection<java.lang.String> mapping)

getLoginMappings

public final java.util.HashSet<java.lang.String> getLoginMappings()

getFilestoreId

public final java.lang.Integer getFilestoreId()

setFilestoreId

public final void setFilestoreId(java.lang.Integer filestore_id)

getMaxQuota

public final java.lang.Long getMaxQuota()

Returns:

max Quota (in MB)

setMaxQuota

public final void setMaxQuota(java.lang.Long maxQuota)

Parameters:

maxQuota - (in MB)

getUsedQuota

public final java.lang.Long getUsedQuota()

Returns:

used Quota (in MB)

setUsedQuota

public final void setUsedQuota(java.lang.Long usedQuota)

getMaintenanceReason

public final MaintenanceReason getMaintenanceReason()

setMaintenanceReason

public final void setMaintenanceReason(MaintenanceReason maintenanceReason)

isEnabled

public final java.lang.Boolean isEnabled()

setEnabled

public final void setEnabled(java.lang.Boolean enabled)

getReadDatabase

public final Database getReadDatabase()

setReadDatabase

public final void setReadDatabase(Database readDatabase)

getWriteDatabase

public final Database getWriteDatabase()

setWriteDatabase

public final void setWriteDatabase(Database writeDatabase)

getAverage_size

public final java.lang.Long getAverage_size()

Returns:

configured average size (in MB)

setAverage_size

public final void setAverage_size(java.lang.Long average_size)

The context average size can only be configured in AdminDaemon.properties

getFilestore_name

public final java.lang.String getFilestore_name()

setFilestore_name

public final void setFilestore_name(java.lang.String filestore_name)

toString

public java.lang.String toString()

Description copied from class: EnforceableDataObject

Overrides:

toString in class ExtendableDataObject

getMandatoryMembersChange

public java.lang.String[] getMandatoryMembersChange()

At the moment no fields are defined here

Specified by:

getMandatoryMembersChange in class EnforceableDataObject

Returns:

String array containing names of mandatory members or null if unwanted

getMandatoryMembersCreate

public java.lang.String[] getMandatoryMembersCreate()

At the moment setId(java.lang.Integer) and setMaxQuota(java.lang.Long) are defined here

Specified by:

getMandatoryMembersCreate in class EnforceableDataObject

Returns:

String array containing names of mandatory members or null if unwanted

getMandatoryMembersDelete

public java.lang.String[] getMandatoryMembersDelete()

At the moment no fields are defined here

Specified by:

getMandatoryMembersDelete in class EnforceableDataObject

Returns:

String array containing names of mandatory members or null if unwanted

getMandatoryMembersRegister

public java.lang.String[] getMandatoryMembersRegister()

At the moment no fields are defined here

Specified by:

getMandatoryMembersRegister in class EnforceableDataObject

Returns:

String array containing names of mandatory members or null if unwanted

getQuotas

public java.util.List<java.lang.Object[]> getQuotas()

Gets the quotas

  (["calendar", 1000000L], ["contact", 1000000L], ...)
 

Returns:

The quotas

setQuotas

public void setQuotas(java.util.List<java.lang.Object[]> quotas)

Sets the quotas

  (["calendar", 1000000L], ["contact", 1000000L], ...)
 

Parameters:

quotas - The quotas to set

isAverage_sizeset

public boolean isAverage_sizeset()

Returns:

the average_sizeset

isEnabledset

public boolean isEnabledset()

Returns:

the enabledset

isFilestore_idset

public boolean isFilestore_idset()

Returns:

the filestore_idset

isFilestore_nameset

public boolean isFilestore_nameset()

Returns:

the filestore_nameset

isIdset

public boolean isIdset()

Returns:

the idset

isMaintenanceReasonset

public boolean isMaintenanceReasonset()

Returns:

the maintenanceReasonset

isMaxQuotaset

public boolean isMaxQuotaset()

Returns:

the maxQuotaset

isNameset

public boolean isNameset()

Returns:

the nameset

isReadDatabaseset

public boolean isReadDatabaseset()

Returns:

the readDatabaseset

isUsedQuotaset

public boolean isUsedQuotaset()

Returns:

the usedQuotaset

isWriteDatabaseset

public boolean isWriteDatabaseset()

Returns:

the writeDatabaseset

setUserAttribute

public void setUserAttribute(java.lang.String namespace,
                    java.lang.String name,
                    java.lang.String value)

Sets a generic user attribute

getUserAttribute

public java.lang.String getUserAttribute(java.lang.String namespace,
                                java.lang.String name)

Read a generic user attribute

getUserAttributes

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getUserAttributes()

setUserAttributes

public void setUserAttributes(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> userAttributes)

getNamespace

public java.util.Map<java.lang.String,java.lang.String> getNamespace(java.lang.String namespace)

isUserAttributesset

public boolean isUserAttributesset()

Used to check if the user attributes have been modified

hashCode

public int hashCode()

Overrides:

hashCode in class ExtendableDataObject

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ExtendableDataObject

getEnabled

public java.lang.Boolean getEnabled()

isListrun

public final boolean isListrun()

This settings are only used internally, don't manipulate the setting here or rely on this methods existence

Returns:

setListrun

public final void setListrun(boolean listrun)

This settings are only used internally, don't manipulate the setting here or rely on this methods existence

Parameters:

listrun -