com.webmethods.caf.faces.data.csp
Class CSPBaseProvider

java.lang.Object
  com.webmethods.caf.faces.bean.BaseFacesBean
      com.webmethods.caf.faces.bean.BaseFacesSessionBean
          com.webmethods.caf.faces.data.csp.CSPBaseProvider

All Implemented Interfaces:

IPageFlowScopeAdapter, Serializable

Direct Known Subclasses:

CSPAttachmentsProvider, CSPContent, CSPContentSearchProvider, CSPIndexDefinitionProvider, CSPNodesProvider, CSPRefreshableContentBaseProvider

public abstract class CSPBaseProvider
extends BaseFacesSessionBean
implements Serializable

This is a basic provider.Its main purpose is to set/get retrivalModule which is a mandatory object for communication with CSP. In order to be functional some inner providers like CSPContent, CSPContentSearchProvider, CSPNodesProvider, CSPIndexDefinitionProvider need session so it is good to extend this provider.

See Also:

Serialized Form

Field Summary

protected RetrievalModule	fRetrievalModule
protected COMMProxy.Session	fSession

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

fExpireWithPageFlow

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

DATA_BINDING_CLIENTS, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders

Constructor Summary

CSPBaseProvider()

Method Summary

protected void	checkState() Check if a RetrievalModule has been properly inited.If not it most probably means a session is not set.
COMMProxy.Session	getSession() Get Session which is the client primary access point to the CSP server.
protected void	release() Override this method to release any resources associated with this session.
void	setSession(COMMProxy.Session session) Sets a Session object in order to communicate with CSP.

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

getExpireWithPageFlow, setExpireWithPageFlow, valueBound, valueUnbound

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

createMethodBinding, createValueBinding, error, error, error, error, error, getBean, getFacesContext, getLocale, getResourceInputStream, getResources, getResourcesProvider, getRootCause, getStackTrace, getTreeAttribute, isUserInRole, log, log, log, putTreeAttribute, resetDataBindingClients, resolveDataBinding, resolveDataBinding, resolveExpression, setValue

Methods inherited from class java.lang.Object

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

Field Detail

fRetrievalModule

protected transient RetrievalModule fRetrievalModule

fSession

protected transient COMMProxy.Session fSession

Constructor Detail

CSPBaseProvider

public CSPBaseProvider()

Method Detail

setSession

public void setSession(COMMProxy.Session session)
                throws COMM_Exception

Sets a Session object in order to communicate with CSP. This is mandatory.

Parameters:

session - The communication session

Throws:

COMM_Exception

getSession

public COMMProxy.Session getSession()

Get Session which is the client primary access point to the CSP server.

Returns:

the session

checkState

protected void checkState()

Check if a RetrievalModule has been properly inited.If not it most probably means a session is not set.

release

protected void release()

Description copied from class: BaseFacesSessionBean

Override this method to release any resources associated with this session. Please note, the FacesContext is not valid for this function

Specified by:

release in class BaseFacesSessionBean