|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BaseContext
Base interface for ComponentContext
and EndpointContext
Method Summary | ||
---|---|---|
MutableRequestContext |
createMutableRequestContext()
Creates a MutableRequestContext that the component can use to set contextual information for a request. |
|
MutableRequestContext |
createMutableRequestContext(RequestContext initialRequestContext)
Creates a MutableRequestContext that the component can use to set contextual information for a request. |
|
RequestContext |
createRequestContextFromBytes(byte[] bytes)
Create a RequestContext from byte array |
|
java.lang.String |
getApplicationName()
Returns the name of the application that this instance of the component is part of. |
|
org.osgi.framework.BundleContext |
getBundleContext()
Returns the BundleContext that should be used to access OSGi metadata for the component. |
|
java.lang.ClassLoader |
getClassLoader()
Returns the ClassLoader that should be used to load resources used by the component. |
|
java.lang.String |
getComponentName()
Returns the name of the component. |
|
java.lang.String |
getComponentRevision()
Returns the revision of the component. |
|
java.lang.String |
getComponentVersion()
Returns the version of the component. |
|
org.slf4j.Logger |
getContextLogger()
Returns the Logger that should be used for context logging for this component. |
|
java.lang.String |
getDesignURI()
Returns the URI of the component at design time. |
|
java.lang.String |
getEnvironmentName()
Returns the name of the environment that this instance of the component is running on. |
|
java.lang.String |
getHostName()
Returns the name of the host that this instance of the component is running on. |
|
LifeCycleEvent |
getLifeCycleEvent()
Returns the LifeCycleEvent describing the life cycle change, if the component/endpoint is currently
processing a life cycle change, otherwise returns null. |
|
org.slf4j.Logger |
getLogger()
Returns the Logger that should be used to log messages for the component. |
|
javax.management.MBeanServer |
getMBeanServer()
Returns the MBeanServer that should be used to expose MBeans for the component. |
|
org.slf4j.Logger |
getMessageLogger()
Returns the Logger that should be used for message logging for this component. |
|
java.lang.String |
getNodeName()
Returns the name of the node that this instance of the component is running on. |
|
com.tibco.amf.sca.model.extensionpoints.Policy[] |
getPolicies()
Returns the policies that are applicable for this component/endpoint, null if none are defined. |
|
|
getPolicyProperty(com.tibco.amf.sca.model.extensionpoints.Policy policy,
java.lang.Class<B> type,
java.lang.String propertyName)
Returns the value of a property defined by the given policy. |
|
|
getProperty(java.lang.Class<B> type,
java.lang.String propertyName)
Returns the value of a property defined by this context. |
|
java.lang.String[] |
getPropertyNames()
Returns all property names defined for this context. |
|
javax.resource.spi.ResourceAdapter |
getResourceAdapter(java.lang.Class<?> messageListenerType,
java.lang.Class<? extends javax.resource.spi.ActivationSpec> activationSpecType)
Returns the JCA ResourceAdapter given message listener and activation specification types, null if none
found. |
|
javax.transaction.TransactionManager |
getTransactionManager()
Returns the TransactionManager that should be used for managing transaction with the component |
|
java.lang.String |
getTypeDisplayName()
Returns the display name for the implementation/binding type for this component. |
|
java.lang.String |
getURI()
Returns the absolute URI of the component. |
|
URLToFileConverter |
getURLToFileConverter()
Returns the URLToFileConverter that should be used to convert URL to files for the component. |
|
javax.transaction.UserTransaction |
getUserTransaction()
Provides the UserTransaction that allows the application to explicitly manage transactions boundaries. |
|
java.io.File |
getWorkArea()
Returns the File that should be used to store data for the component. |
Method Detail |
---|
java.lang.String[] getPropertyNames()
<B> B getProperty(java.lang.Class<B> type, java.lang.String propertyName)
B
- the Java type of the propertytype
- the Java type to be returned for the propertypropertyName
- the name of the property whose value should be returned
java.lang.ClassLoader getClassLoader()
ClassLoader
that should be used to load resources used by the component.
ClassLoader
javax.management.MBeanServer getMBeanServer()
MBeanServer
that should be used to expose MBeans for the component.
MBeanServer
java.lang.String getURI()
java.lang.String getNodeName()
java.lang.String getHostName()
java.lang.String getEnvironmentName()
java.lang.String getApplicationName()
java.lang.String getComponentName()
java.lang.String getComponentVersion()
java.lang.String getComponentRevision()
java.lang.String getDesignURI()
javax.resource.spi.ResourceAdapter getResourceAdapter(java.lang.Class<?> messageListenerType, java.lang.Class<? extends javax.resource.spi.ActivationSpec> activationSpecType)
Returns the JCA ResourceAdapter
given message listener and activation specification types, null if none
found.
messageListenerType
- message listener typeactivationSpecType
- activation specification type
javax.transaction.TransactionManager getTransactionManager()
TransactionManager
that should be used for managing transaction with the component
TransactionManager
javax.transaction.UserTransaction getUserTransaction()
UserTransaction
that allows the application to explicitly manage transactions boundaries.
UserTransaction
URLToFileConverter getURLToFileConverter()
URLToFileConverter
that should be used to convert URL to files for the component.
URLToFileConverter
org.slf4j.Logger getLogger()
Logger
that should be used to log messages for the component.
Logger
org.slf4j.Logger getMessageLogger()
Logger
that should be used for message logging for this component.
Logger
for this componentorg.slf4j.Logger getContextLogger()
Logger
that should be used for context logging for this component.
Logger
for this componentjava.io.File getWorkArea()
File
that should be used to store data for the component.
org.osgi.framework.BundleContext getBundleContext()
BundleContext
that should be used to access OSGi metadata for the component.
BundleContext
MutableRequestContext createMutableRequestContext()
MutableRequestContext
that the component can use to set contextual information for a request.
MutableRequestContext
to use for requestsMutableRequestContext createMutableRequestContext(RequestContext initialRequestContext)
MutableRequestContext
that the component can use to set contextual information for a request.
The given RequestContext
is used to initialize the created context. The security subject, correlation ID
and conversation are copied from that context.
initialRequestContext
- the RequestContext
to use to initialize the returned context
MutableRequestContext
to use for requestsjava.lang.String getTypeDisplayName()
com.tibco.amf.sca.model.extensionpoints.Policy[] getPolicies()
<B> B getPolicyProperty(com.tibco.amf.sca.model.extensionpoints.Policy policy, java.lang.Class<B> type, java.lang.String propertyName)
B
- the Java type of the propertypolicy
- the policy defining the propertytype
- the Java type to be returned for the propertypropertyName
- the name of the property whose value should be returned
LifeCycleEvent getLifeCycleEvent()
Returns the LifeCycleEvent
describing the life cycle change, if the component/endpoint is currently
processing a life cycle change, otherwise returns null.
RequestContext createRequestContextFromBytes(byte[] bytes) throws java.lang.Exception
RequestContext
from byte array
bytes
- Byte Array to construct RequestContext from
java.lang.Exception
- in case a problem creating the RequestContext
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |