|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.webcenter.framework.application.context.WebCenterApplicationContext
oracle.webcenter.webcenterapp.context.WCApplicationContext
public abstract class WCApplicationContext
WCApplicationContext is responsible for managing WebCenter Application Context across the WebCenter Application. It contains all the context/state information related to WebCenter Application.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class oracle.webcenter.framework.application.context.WebCenterApplicationContext |
---|
oracle.webcenter.framework.application.context.WebCenterApplicationContext.Mode |
Field Summary |
---|
Fields inherited from class oracle.webcenter.framework.application.context.WebCenterApplicationContext |
---|
CURRENT_SELECTED_RESOURCE, SRM_CURR_RESOURCE_TYPE |
Constructor Summary | |
---|---|
WCApplicationContext() |
Method Summary | ||
---|---|---|
abstract oracle.mds.core.MDSSession |
createCustomizeModeMDSSession() Create and return a new MDS Session based on the customize mode mappings. |
|
abstract oracle.mds.core.MDSSession |
createEditModeMDSSession() Create and return a new MDS Session based on the edit mode mappings. |
|
abstract oracle.mds.core.MDSSession |
createMDSSession() Create and return a new MDS Session based on the view mode mappings. |
|
abstract void |
displayError(oracle.webcenter.webcenterapp.WebCenterException ex) This method logs the error and display it in UI. |
|
abstract void |
displayWarning(java.lang.String resourceBundleClassName, java.lang.String key, java.lang.String[] args) This method display the warning |
|
abstract
|
evaluateExpression(java.lang.String expression, java.lang.Class<T> returnType) This API evaluates a given expression |
|
WCApplication |
getApplication() Return the WCApplication instance associated with this web application. |
|
abstract java.lang.String |
getApplicationURL() Gets the application's URL - http[s]://host:port/webcenter. |
|
abstract java.lang.String |
getChromeLevelForCurrentRequest() Returns the chrome-level to be used, if it can be determined from the current request or page. |
|
abstract java.lang.String |
getContextURL(java.lang.String scopeName) Returns the context URL for the given scope |
|
static WCApplicationContext |
getCurrentInstance() Return the WCApplicationContext instance for the request that is being processed by the current thread, if any. |
|
abstract oracle.webcenter.portalframework.genericsiteresources.GenericSiteResource |
getCurrentPageTemplate() Returns a page template object of type GenericSiteResource used for current request. |
|
abstract oracle.webcenter.framework.service.Scope |
getCurrentScope() Returns a scope object corresponding to the current WC context. |
|
abstract java.lang.String |
getCurrentScopedWebCenterURI() Returns a URI that represents the current request (including request parameters recognized by WebCenter) in the context of the current scope. |
|
abstract java.lang.String |
getCurrentTaskFlowID() get the current taskflow id. |
|
abstract java.lang.String |
getCurrentWebCenterURI() Method to get the a URI that represents the current request (including request parameters that are recognized by WebCenter). |
|
abstract oracle.mds.core.MetadataObject |
getEditModeMO(oracle.mds.core.MDSSession session, java.lang.String documentPath, boolean isPersonalizeMode) Returns the edit only MetadataObject for a particular document. |
|
abstract java.util.Map<java.lang.String,java.lang.Object> |
getEnvProperties() Returns a map of the current WebCenter application's environment configuration properties. |
|
abstract java.lang.String |
getGroupSpaceURL(java.lang.String GroupSpaceName) return the pretty url for the named Group Space |
|
abstract java.lang.String |
getGSTemplateURL(java.lang.String templateName) return the pretty url for the named TemplateName |
|
oracle.mds.core.MDSSession |
getMDSSession() Returns an MDS session associated with the current WCApplicationContext . |
|
abstract java.lang.String |
getNavigableURL(javax.servlet.http.HttpServletRequest hreq, java.lang.String destinationURI) Determines the URL with all the request parameters propagated to the new URL for the given destinationURI |
|
abstract java.lang.String |
getNavigableURL(java.lang.String viewIdWithParams) Constructs a URL suitable for navigation within the context of the current WebCenter App, based on the specified URI. |
|
abstract java.lang.String |
getNavigableURL(java.lang.String viewIdWithParams, java.util.Map<java.lang.String,java.lang.String> overridingNavigationParams) Similar to getNavigbleURL(viewIdWithParams) but provides the option to override the parameters that would appear in the constructed URL. |
|
abstract java.lang.String |
getPortalTemplateURL(java.lang.String templateName) return the pretty url for the named TemplateName |
|
abstract PreferencesManager |
getPreferencesManager() |
|
abstract oracle.webcenter.portalframework.genericsiteresources.GenericSiteResource |
getPreviouslySetPageTemplate() Returns a site template object of type GenericSiteResource used for previous request. |
|
abstract java.lang.String |
getProtocol() Gets the application's protocol scheme - http[s]:// |
|
abstract java.lang.String |
getRequestProperty(java.lang.String key, java.util.Map parameterMap, java.util.Map sessionMap) Return the value of the known webcenter param. |
|
abstract java.util.Map |
getRequestScopeMap() This method returns the session scope map for the current thread. |
|
abstract java.lang.String |
getServicesScriptsUrl() Return the path of webcenter services script url |
|
abstract java.util.Map<java.lang.String,java.lang.Object> |
getSessionProperties() Returns a place for WebCenter can use to store and retrieve information during the lifetime of the current user session. |
|
abstract oracle.mds.core.MDSSession |
getSiteCCSession(java.lang.String documentPath) Definition of an abstract method to get MDSSession with oracle.webcenter.webcenterapp.internal.metadata.WebCenterSiteCC customization. |
|
abstract java.lang.String |
getSpacesResourcesPath() Returns the servlet path for WebCenter Spaces resources whose loading is controlled specifically by the application, such as custom logos and icons uploaded by users. |
|
abstract java.lang.String |
getSpacesScriptsUrl() Return the path of webcenter spaces script url |
|
abstract java.lang.String |
getSpacesURL() return the pretty url for Personal Space |
|
abstract oracle.mds.core.MDSSession |
getTFISiteCCSession(java.lang.String documentPath) Definition of an abstract method to get MDSSession with oracle.webcenter.webcenterapp.internal.metadata.WebCenterTFISiteCC customization. |
|
abstract oracle.mds.core.MetadataObject |
getViewModeMO(oracle.mds.core.MDSSession session, java.lang.String documentPath, boolean isPersonalizeMode) Returns the view only MetadataObject for a particular document. |
|
abstract oracle.webcenter.webcenterapp.concurrent.WCLockManager |
getWCLockManager() This API gets the lock manager for current instance |
|
static boolean |
isWCApplicationCustomized() Checks if the WCApplication has been customized, if yes then returns true, false otherwise. |
|
abstract void |
launchInEditMode(java.lang.String viewIdWithParams) Launches the specified page in edit mode. |
|
abstract void |
navigateToURI(java.lang.String viewIdWithParams) Navigate to the specified URI in the context of the current WebCenter App. |
|
abstract void |
navigateToURI(java.lang.String viewIdWithParams, java.util.Map<java.lang.String,java.lang.String> overridingNavigationParams) Similar to navigateToURI(viewIdWithParams) but provides the option to override the URL parameters that would be used during navigation. |
|
static void |
releaseCachedContext() Release all the cached WCApplication Context instances which are specific to local threads |
|
protected static void |
setCurrentInstance(WCApplicationContext context) Set the WCApplicationContext instance for the request that is being processed by the current thread. |
Methods inherited from class oracle.webcenter.framework.application.context.WebCenterApplicationContext |
---|
getAppCustomPropertyValue, getEditLayer, getHomeURL, getScopeCustomPropertyValue, navigateToURI, setEditLayer, unsetEditLayer |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WCApplicationContext()
Method Detail |
---|
public abstract PreferencesManager getPreferencesManager()
public static void releaseCachedContext()
Release all the cached WCApplication Context instances which are specific to local threads
public WCApplication getApplication()
Return the WCApplication
instance associated with this web application.
EL: #{WCAppContext.application}
WCApplication
object associated with the web application.public oracle.mds.core.MDSSession getMDSSession()
WCApplicationContext
. It has the same properties (cust config, user state handler) as that of an MDS session obtained from the current ADF context. It is initialized in the first call to this method on the current instance, and returned on that and subsequent calls on the current instance.public static WCApplicationContext getCurrentInstance()
WCApplicationContext
instance for the request that is being processed by the current thread, if any.
EL: #{WCAppContext}
public abstract java.lang.String getSpacesURL()
return the pretty url for Personal Space
public abstract oracle.mds.core.MDSSession createMDSSession()
public abstract oracle.mds.core.MDSSession createEditModeMDSSession()
createEditModeMDSSession
in class oracle.webcenter.framework.application.context.WebCenterApplicationContext
public abstract oracle.mds.core.MDSSession createCustomizeModeMDSSession()
public abstract oracle.mds.core.MetadataObject getViewModeMO(oracle.mds.core.MDSSession session, java.lang.String documentPath, boolean isPersonalizeMode) throws oracle.webcenter.webcenterapp.WebCenterException
oracle.webcenter.webcenterapp.WebCenterException
public abstract oracle.mds.core.MetadataObject getEditModeMO(oracle.mds.core.MDSSession session, java.lang.String documentPath, boolean isPersonalizeMode) throws oracle.webcenter.webcenterapp.WebCenterException
oracle.webcenter.webcenterapp.WebCenterException
public abstract java.lang.String getSpacesResourcesPath()
EL: #{WCAppContext.spacesResourcesPath}
public abstract java.lang.String getSpacesScriptsUrl()
public abstract java.lang.String getServicesScriptsUrl()
public abstract java.lang.String getCurrentTaskFlowID()
public abstract java.lang.String getRequestProperty(java.lang.String key, java.util.Map parameterMap, java.util.Map sessionMap)
key
- the known webcenter parameter name like we.contextURL.parameterMap
- parameterssessionMap
-public abstract java.lang.String getChromeLevelForCurrentRequest()
public abstract java.lang.String getGroupSpaceURL(java.lang.String GroupSpaceName)
return the pretty url for the named Group Space
public abstract java.lang.String getContextURL(java.lang.String scopeName)
public abstract java.lang.String getGSTemplateURL(java.lang.String templateName)
return the pretty url for the named TemplateName
public abstract java.lang.String getPortalTemplateURL(java.lang.String templateName)
return the pretty url for the named TemplateName
public abstract oracle.webcenter.webcenterapp.concurrent.WCLockManager getWCLockManager()
This API gets the lock manager for current instance
public abstract oracle.webcenter.framework.service.Scope getCurrentScope()
EL: #{WCAppContext.currentScope}
public abstract java.util.Map getRequestScopeMap()
public abstract java.util.Map<java.lang.String,java.lang.Object> getSessionProperties()
public abstract java.lang.String getCurrentWebCenterURI()
EL: #{WCAppContext.currentWebCenterURI}
public abstract java.lang.String getCurrentScopedWebCenterURI()
The URI returned by this method would not provide any explicit indication about what WebCenter scope the current request represents.
public abstract java.lang.String getNavigableURL(java.lang.String viewIdWithParams)
viewIdWithParams
- The URI to be navigated to. It is expected to be a JSF view-id (i.e. an ADFc view-id or physical page path), and can also contain parameters through a HTTP URL-like syntax which will get evaluated as HTTP request parameters after the redirection is done. Examples:
/defaultScope_something?someParam=someValue
"/oracle/webcenter/somePage.jspx?p1=v1&p2=v2
"/xyz?a=b
"public abstract java.lang.String getNavigableURL(javax.servlet.http.HttpServletRequest hreq, java.lang.String destinationURI)
hreq
- the request objectdestinationURI
- the URI for which page path ahs to be determinedpublic abstract java.lang.String getNavigableURL(java.lang.String viewIdWithParams, java.util.Map<java.lang.String,java.lang.String> overridingNavigationParams)
getNavigbleURL(viewIdWithParams)
but provides the option to override the parameters that would appear in the constructed URL.
For any parameter that may find appearance in the constructed URL, if its value has been specified in overridingparams
then that value would be used, otherwise a default would be used for it.
viewIdWithParams
- Same as for getNavigateURL(viewIdWithParams)
.overridingNavigationParams
- Map specifying values of parameters that should override the default parameters in the constructed URL.public abstract void navigateToURI(java.lang.String viewIdWithParams)
viewIdWithParams
- The URI to be navigated to. It is expected to be a JSF view-id (i.e. an ADFc view-id or physical page path), and can also contain parameters through a HTTP URL-like syntax which will get evaluated as HTTP request parameters after the redirection is done. Examples:
/defaultScope_something?someParam=someValue
"/oracle/webcenter/somePage.jspx?p1=v1&p2=v2
"/xyz?a=b
"public abstract void navigateToURI(java.lang.String viewIdWithParams, java.util.Map<java.lang.String,java.lang.String> overridingNavigationParams)
navigateToURI(viewIdWithParams)
but provides the option to override the URL parameters that would be used during navigation.
For any URL parameter that may find appearance in the destination URL, if its value has been specified in overridingparams
then that value would be used, otherwise a default would be used for it.
viewIdWithParams
- Same as for navigateToURI(viewIdWithParams)
.overridingNavigationParams
- Map specifying values of parameters that should override the default parameters in the navigation destination URL.public abstract void launchInEditMode(java.lang.String viewIdWithParams)
viewIdWithParams
- The URI to be navigated to. It is expected to be a JSF view-id (i.e. an ADFc view-id or physical page path), and can also contain parameters through a HTTP URL-like syntax which will get evaluated as HTTP request parameters after the redirection is done. Examples:
/defaultScope_something?someParam=someValue
"/oracle/webcenter/somePage.jspx?p1=v1&p2=v2
"/xyz?a=b
"public abstract java.util.Map<java.lang.String,java.lang.Object> getEnvProperties()
public abstract void displayError(oracle.webcenter.webcenterapp.WebCenterException ex)
public abstract void displayWarning(java.lang.String resourceBundleClassName, java.lang.String key, java.lang.String[] args)
public abstract java.lang.String getApplicationURL()
EL: #{WCAppContext.applicationURL}
public abstract java.lang.String getProtocol()
public static final boolean isWCApplicationCustomized()
protected static void setCurrentInstance(WCApplicationContext context)
Set the WCApplicationContext
instance for the request that is being processed by the current thread.
context
- The WCApplicationContext
instance for the current thread, or null
if this thread no longer has a WCApplicationContext
instance.public abstract oracle.mds.core.MDSSession getSiteCCSession(java.lang.String documentPath)
MDSSession
with oracle.webcenter.webcenterapp.internal.metadata.WebCenterSiteCC
customization.documentPath
- - The document for which the MDSSession is requestedMDSSession
objectpublic abstract oracle.mds.core.MDSSession getTFISiteCCSession(java.lang.String documentPath)
MDSSession
with oracle.webcenter.webcenterapp.internal.metadata.WebCenterTFISiteCC
customization.documentPath
- - The document for which the MDSSession is requestedMDSSession
objectpublic abstract oracle.webcenter.portalframework.genericsiteresources.GenericSiteResource getCurrentPageTemplate()
GenericSiteResource
used for current request.
EL: #{WCAppContext.currentPageTemplate}
GenericSiteResource
object used for current request.public abstract oracle.webcenter.portalframework.genericsiteresources.GenericSiteResource getPreviouslySetPageTemplate()
GenericSiteResource
used for previous request.
EL: #{WCAppContext.previouslySetPageTemplate}
GenericSiteResource
object used for the previous request.public abstract <T> T evaluateExpression(java.lang.String expression, java.lang.Class<T> returnType)
T
- T The type of the object the expresssion will evalate toexpresssion
- the expression to be evaluated
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |