Package org.opencms.main

Class CmsContextInfo

java.lang.Object

org.opencms.main.CmsContextInfo

All Implemented Interfaces:

Serializable

public class CmsContextInfo
extends Object
implements Serializable

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

Since:

6.0.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_REQUEST_TIME	Name of the http session attribute the request time is stored in.
static final long	CURRENT_TIME	Indicates the request time should always be the current time.
static final String	LOCALHOST	Localhost ip used in fallback cases.

Constructor Summary

Constructors

Constructor	Description
CmsContextInfo()	Creates a new instance, initializing the variables with some reasonable default values.
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(CmsRequestContext requestContext)	Creates a new instance with all context variables initialized from the given request context.
CmsContextInfo(CmsUser user, CmsProject project, String requestedUri, CmsSiteMatcher requestMatcher, String siteRoot, boolean isSecureRequest, Locale locale, String encoding, String remoteAddr, long requestTime, String ouFqn, boolean isForceAbsoluteLinks)	Creates a new instance with all context variables initialized.

Method Summary

Modifier and Type	Method	Description
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.
CmsResource	getDetailResource()	Gets the detail content resource.
String	getEncoding()	Returns the encoding.
Locale	getLocale()	Returns the locale.
String	getLocaleName()	Returns the locale name.
String	getOuFqn()	Returns the fully qualified name of the organizational unit.
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.
CmsSiteMatcher	getRequestMatcher()	Returns the matcher for the current request, that is the host part of the URI from the original http request.
long	getRequestTime()	Returns the request time used for validation of resource publication and expiration dates.
String	getSiteRoot()	Returns the siteroot.
CmsUser	getUser()	Returns the user, or null if the user has not been configured.
String	getUserName()	Returns the username.
boolean	isForceAbsoluteLinks()	Returns true if links to the current site should be generated with a server prefix.
boolean	isSecureRequest()	Returns true if this a secure request.
void	setDetailResource(CmsResource detailResource)	Sets the detail content resource.
void	setEncoding(String encoding)	Sets the encoding.
void	setForceAbsoluteLinks(boolean isForceAbsoluteLinks)	Enables/disables usage of the server prefix for links to the current site.
void	setIsSecureRequest(boolean isSecureRequest)	Sets the 'isSecureRequest' attribute.
void	setLocale(Locale locale)	Sets the locale.
void	setLocaleName(String localeName)	Sets the locale name.
void	setOuFqn(String ouFqn)	Sets the fully qualified name of the organizational unit.
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	setRequestMatcher(CmsSiteMatcher requestMatcher)	Sets the matcher for the current request, that is the host part of the URI from the original http request.
void	setRequestTime(long requestTime)	Sets the request time used for validation of resource publication and expiration dates.
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 Details

ATTRIBUTE_REQUEST_TIME

public static final String ATTRIBUTE_REQUEST_TIME

Name of the http session attribute the request time is stored in.

See Also:

• Constant Field Values

CURRENT_TIME

public static final long CURRENT_TIME

Indicates the request time should always be the current time.

See Also:

• Constant Field Values

LOCALHOST

public static final String LOCALHOST

Localhost ip used in fallback cases.

See Also:

• Constant Field Values

Constructor Details

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

Organizational unit

/

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,
 CmsSiteMatcher requestMatcher,
 String siteRoot,
 boolean isSecureRequest,
 Locale locale,
 String encoding,
 String remoteAddr,
 long requestTime,
 String ouFqn,
 boolean isForceAbsoluteLinks)

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

requestMatcher - the matcher for the current request, that is the host part of the URI from the original http request

siteRoot - the site root to create the context with

isSecureRequest - if this a secure request

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

requestTime - the time of the request (used for resource publication / expiration date)

ouFqn - the fully qualified name of the organizational unit to create the context with

isForceAbsoluteLinks - a flag indicating whether links to the current site should be generated with a server prefix

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()

Method Details

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.

getDetailResource

public CmsResource getDetailResource()

Gets the detail content resource.

Returns:

the detail content resource

getEncoding

public String getEncoding()

Returns the encoding.

Returns:

the encoding

See Also:

• CmsRequestContext.getEncoding()

getLocale

public Locale getLocale()

Returns the locale.

Returns:

the locale

See Also:

• CmsRequestContext.getLocale()

getLocaleName

public String getLocaleName()

Returns the locale name.

Returns:

the locale name

See Also:

• CmsRequestContext.getLocale()

getOuFqn

public String getOuFqn()

Returns the fully qualified name of the organizational unit.

Returns:

the fully qualified name of the organizational unit

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()
• CmsRequestContext.getCurrentProject()

getProjectName

public String getProjectName()

Returns the project name.

Returns:

the project name

See Also:

• getProject()
• CmsRequestContext.getCurrentProject()

getRemoteAddr

public String getRemoteAddr()

Returns the remote ip address.

Returns:

the remote ip address

See Also:

• CmsRequestContext.getRemoteAddress()

getRequestedUri

public String getRequestedUri()

Returns the requested uri.

Returns:

the requested uri

See Also:

• CmsRequestContext.getUri()

getRequestMatcher

public CmsSiteMatcher getRequestMatcher()

Returns the matcher for the current request, that is the host part of the URI from the original http request.

Returns:

the matcher for the current request, that is the host part of the URI from the original http request

getRequestTime

public long getRequestTime()

Returns the request time used for validation of resource publication and expiration dates.

Returns:

the request time used for validation of resource publication and expiration dates

See Also:

• CmsRequestContext.getRequestTime()

getSiteRoot

public String getSiteRoot()

Returns the siteroot.

Returns:

the siteroot

See Also:

• CmsRequestContext.getSiteRoot()

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()
• CmsRequestContext.getCurrentUser()

getUserName

public String getUserName()

Returns the username.

Returns:

the username

See Also:

• getUser()
• CmsRequestContext.getCurrentUser()

isForceAbsoluteLinks

public boolean isForceAbsoluteLinks()

Returns true if links to the current site should be generated with a server prefix.

Returns:

true if links to current site should be absolute

isSecureRequest

public boolean isSecureRequest()

Returns true if this a secure request.

Returns:

true if this is a secure request

setDetailResource

public void setDetailResource(CmsResource detailResource)

Sets the detail content resource.

Parameters:

detailResource - the detail content resource to set

setEncoding

public void setEncoding(String encoding)

Sets the encoding.

Parameters:

encoding - the encoding to set

See Also:

• CmsRequestContext.setEncoding(String)

setForceAbsoluteLinks

public void setForceAbsoluteLinks(boolean isForceAbsoluteLinks)

Enables/disables usage of the server prefix for links to the current site.

Parameters:

isForceAbsoluteLinks - true if links to the current site should be generated with a server prefix

setIsSecureRequest

public void setIsSecureRequest(boolean isSecureRequest)

Sets the 'isSecureRequest' attribute.

Parameters:

isSecureRequest - true if this a secure request

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)
• CmsRequestContext.getLocale()

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)
• CmsRequestContext.getLocale()

setOuFqn

public void setOuFqn(String ouFqn)

Sets the fully qualified name of the organizational unit.

Parameters:

ouFqn - the fully qualified name of the organizational unit to set

setProjectName

public void setProjectName(String projectName)

Sets the project name.

Parameters:

projectName - the project name to set

See Also:

• CmsRequestContext.getCurrentProject()

setRemoteAddr

public void setRemoteAddr(String remoteAddr)

Sets the remote ip address.

Parameters:

remoteAddr - the remote ip address

See Also:

• CmsRequestContext.getRemoteAddress()

setRequestedUri

public void setRequestedUri(String requestedUri)

Sets the requested uri.

Parameters:

requestedUri - the requested uri to set

See Also:

• CmsRequestContext.setUri(String)

setRequestMatcher

public void setRequestMatcher(CmsSiteMatcher requestMatcher)

Sets the matcher for the current request, that is the host part of the URI from the original http request.

Parameters:

requestMatcher - the matcher for the current request

setRequestTime

public void setRequestTime(long requestTime)

Sets the request time used for validation of resource publication and expiration dates.

Parameters:

requestTime - the request time to set

See Also:

• CmsRequestContext.getRequestTime()

setSiteRoot

public void setSiteRoot(String siteRoot)

Sets the siteroot.

Parameters:

siteRoot - the siteroot to set

See Also:

• CmsRequestContext.setSiteRoot(String)

setUserName

public void setUserName(String userName)

Sets the username.

Parameters:

userName - the username to set

See Also:

• CmsRequestContext.getCurrentUser()

checkFrozen

protected void checkFrozen()
                    throws CmsRuntimeException

Checks if this context info configuration is frozen.

Throws:

CmsRuntimeException - in case the configuration is already frozen