org.opencms.main
Class CmsContextInfo

java.lang.Object
  org.opencms.main.CmsContextInfo

public class CmsContextInfo
extends Object

Contains user information for automated creation of a CmsRequestContext during system runtime.

Since:

6.0.0

Version:

$Revision: 1.12 $

Field Summary

static String

LOCALHOST Localhost ip used in fallback cases.

Constructor Summary

CmsContextInfo()
Creates a new instance, initializing the variables with some reasonable default values.

CmsContextInfo(CmsRequestContext requestContext)
Creates a new instance with all context variables initialized from the given request context.

CmsContextInfo(CmsUser user, CmsProject project, String requestedUri, String siteRoot, Locale locale, String encoding, String remoteAddr)
Creates a new instance with all context variables initialized.

CmsContextInfo(String userName)
Creates a new instance, initializing the user name as provided and all other vaiables with the same default values as in CmsContextInfo().

CmsContextInfo(String userName, String projectName, String requestedUri, String siteRoot, String localeName, String encoding, String remoteAddr)
Creates a new instance with all context variables initialized.

Method Summary

protected void	checkFrozen() Checks if this context info configuration is frozen.
Object	clone() Creates a clone of this context info object.
void	freeze() Finalizes (freezes) the configuration of this context information.
String	getEncoding() Returns the encoding.
Locale	getLocale() Returns the locale.
String	getLocaleName() Returns the locale name.
CmsProject	getProject() Returns the project, or null if the project has not been configured.
String	getProjectName() Returns the project name.
String	getRemoteAddr() Returns the remote ip address.
String	getRequestedUri() Returns the requested uri.
String	getSiteRoot() Returns the siteroot.
CmsUser	getUser() Returns the user, or null if the user has not been configured.
String	getUserName() Returns the username.
void	setEncoding(String encoding) Sets the encoding.
void	setLocale(Locale locale) Sets the locale.
void	setLocaleName(String localeName) Sets the locale name.
void	setProjectName(String projectName) Sets the project name.
void	setRemoteAddr(String remoteAddr) Sets the remote ip address.
void	setRequestedUri(String requestedUri) Sets the requested uri.
void	setSiteRoot(String siteRoot) Sets the siteroot.
void	setUserName(String userName) Sets the username.

Methods inherited from class java.lang.Object

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

Field Detail

LOCALHOST

public static final String LOCALHOST

Localhost ip used in fallback cases.

See Also:

Constant Field Values

Constructor Detail

CmsContextInfo

public CmsContextInfo()

Creates a new instance, initializing the variables with some reasonable default values.

The default values are:

User name

(configured default guest user)

Project name

Online

Requested URI

/

Site root

/

Locale name

(configured default locale name)

Encoding

(configured default system encoding)

Remote address

127.0.0.1

CmsContextInfo

public CmsContextInfo(CmsRequestContext requestContext)

Creates a new instance with all context variables initialized from the given request context.

Parameters:

requestContext - the request context to initialize this context info with

CmsContextInfo

public CmsContextInfo(CmsUser user,
                      CmsProject project,
                      String requestedUri,
                      String siteRoot,
                      Locale locale,
                      String encoding,
                      String remoteAddr)

Creates a new instance with all context variables initialized.

Parameters:

user - the user to create the context with

project - the project to create the context with

requestedUri - the request URI to create the context with

siteRoot - the site root to create the context with

locale - the locale to create the context with

encoding - the encoding to create the context with

remoteAddr - the remote ip address to create the context with

CmsContextInfo

public CmsContextInfo(String userName)

Creates a new instance, initializing the user name as provided and all other vaiables with the same default values as in CmsContextInfo().

Parameters:

userName - the user name to create the context with

See Also:

CmsContextInfo()

CmsContextInfo

public CmsContextInfo(String userName,
                      String projectName,
                      String requestedUri,
                      String siteRoot,
                      String localeName,
                      String encoding,
                      String remoteAddr)

Creates a new instance with all context variables initialized.

Parameters:

userName - the user name to create the context with

projectName - the project name to create the context with

requestedUri - the request URI to create the context with

siteRoot - the site root to create the context with

localeName - the locale name to create the context with

encoding - the encoding to create the context with

remoteAddr - the remote ip address to create the context with

Method Detail

clone

public Object clone()

Creates a clone of this context info object.

Overrides:

clone in class Object

See Also:

Object.clone()

freeze

public void freeze()

Finalizes (freezes) the configuration of this context information.

After this entry has been frozen, any attempt to change the configuration of this context info with one of the "set..." methods will lead to a RuntimeException.

getEncoding

public String getEncoding()

Returns the encoding.

Returns:

the encoding

getLocale

public Locale getLocale()

Returns the locale.

Returns:

the locale

getLocaleName

public String getLocaleName()

Returns the locale name.

Returns:

the locale name

getProject

public CmsProject getProject()

Returns the project, or null if the project has not been configured.

If the project has not been configured, at last the project name will be available.

Returns:

the project

See Also:

getProjectName()

getProjectName

public String getProjectName()

Returns the project name.

Returns:

the project name

See Also:

getProject()

getRemoteAddr

public String getRemoteAddr()

Returns the remote ip address.

Returns:

the remote ip address

getRequestedUri

public String getRequestedUri()

Returns the requested uri.

Returns:

the requested uri

getSiteRoot

public String getSiteRoot()

Returns the siteroot.

Returns:

the siteroot

getUser

public CmsUser getUser()

Returns the user, or null if the user has not been configured.

If the user has not been configured, at last the user name will be available.

Returns:

the user

See Also:

getUserName()

getUserName

public String getUserName()

Returns the username.

Returns:

the username

See Also:

getUser()

setEncoding

public void setEncoding(String encoding)

Sets the encoding.

Parameters:

encoding - the encoding to set

setLocale

public void setLocale(Locale locale)

Sets the locale.

Setting the locale name will override the currently selected locale and vice-versa. The locale name and the locale will always match.

Parameters:

locale - the locale to set

See Also:

setLocaleName(String)

setLocaleName

public void setLocaleName(String localeName)

Sets the locale name.

Setting the locale name will override the currently selected locale and vice-versa. The locale name and the locale will always match.

Parameters:

localeName - the locale name to set

See Also:

setLocale(Locale)

setProjectName

public void setProjectName(String projectName)

Sets the project name.

Parameters:

projectName - the project name to set

setRemoteAddr

public void setRemoteAddr(String remoteAddr)

Sets the remote ip address.

Parameters:

remoteAddr - the remote ip address

setRequestedUri

public void setRequestedUri(String requestedUri)

Sets the requested uri.

Parameters:

requestedUri - the requested uri to set

setSiteRoot

public void setSiteRoot(String siteRoot)

Sets the siteroot.

Parameters:

siteRoot - the siteroot to set

setUserName

public void setUserName(String userName)

Sets the username.

Parameters:

userName - the username to set

checkFrozen

protected void checkFrozen()
                    throws CmsRuntimeException

Checks if this context info configuration is frozen.

Throws:

CmsRuntimeException - in case the configuration is already frozen