|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The remote interface for the ApplicationView EJB. It represents a STATELESS session EJB. This interface is used internally by the ApplicationView object. It is recommended that clients use the ApplicationView object instead of this remote interface. The ApplicationView provides for adding event listeners, and easier use of async invocation of services (this interface does not provide these facilities).
Method Summary | |
void |
beginLocalTransaction(java.lang.String strInstanceID,
QualifiedName appViewName,
javax.resource.cci.ConnectionSpec spec)
begins a localtransaction. |
void |
checkEventDeployment(QualifiedName appViewName)
Check that events were successfully deployed before allowing a client to register as a listener. |
void |
commitLocalTransaction()
Commits a local transaction and closes allocated resources. |
java.lang.String |
getAsyncResponseQueueJNDIName(QualifiedName appViewName,
java.lang.String strInstanceID)
Returns the name of an async response queue that the client can use to receive responses from for a given application view name. |
IEventDefinition |
getEventDefinition(QualifiedName appViewName,
java.lang.String eventType)
Get IEventDefinition for the given event type. |
IDocumentDefinition |
getRequestDocumentDefinition(QualifiedName appViewName,
java.lang.String serviceName)
Get request DocumentDefinition for the given service. |
IDocumentDefinition |
getResponseDocumentDefinition(QualifiedName appViewName,
java.lang.String serviceName)
Get response IDocumentDefinition for the given service. |
boolean |
inLocalTransaction()
Returns true if the Application View is stateful and a LocalTransaction is in effect. |
IDocument |
invokeService(QualifiedName appViewName,
java.lang.String serviceName,
IDocument request,
boolean autoCreateResponse,
javax.resource.cci.ConnectionSpec spec)
Synchronously invoke the service with the given name, using the request document given. |
IDocument |
invokeService(QualifiedName appViewName,
java.lang.String serviceName,
IDocument request,
boolean autoCreateResponse,
javax.resource.cci.ConnectionSpec spec,
boolean incAsyncCount)
Synchronously invoke the service with the given name, using the request and response documents given. |
IDocument |
invokeService(QualifiedName appViewName,
java.lang.String serviceName,
IDocument request,
javax.resource.cci.ConnectionSpec spec)
Synchronously invoke the service with the given name, using the request document given. |
void |
invokeService(QualifiedName appViewName,
java.lang.String serviceName,
IDocument request,
IDocument response,
javax.resource.cci.ConnectionSpec spec)
Synchronously invoke the service with the given name, using the request and response documents given. |
IDocument |
invokeService(java.lang.String strInstanceID,
QualifiedName appViewName,
java.lang.String serviceName,
IDocument request,
boolean autoCreateResponse,
javax.resource.cci.ConnectionSpec spec)
Synchronously invoke the service with the given name, using the request document given. |
IDocument |
invokeService(java.lang.String strInstanceID,
QualifiedName appViewName,
java.lang.String serviceName,
IDocument request,
boolean autoCreateResponse,
javax.resource.cci.ConnectionSpec spec,
boolean incAsyncCount)
Synchronously invoke the service with the given name, using the request document given. |
IDocument |
invokeService(java.lang.String strInstanceID,
QualifiedName appViewName,
java.lang.String serviceName,
IDocument request,
javax.resource.cci.ConnectionSpec spec)
Synchronously invoke the service with the given name, using the request document given. |
IDocument |
invokeService(java.lang.String strInstanceID,
QualifiedName appViewName,
java.lang.String serviceName,
IDocument request,
javax.resource.cci.ConnectionSpec spec,
boolean incAsyncCount)
Synchronously invoke the service with the given name, using the request document given. |
void |
invokeService(java.lang.String strInstanceID,
QualifiedName appViewName,
java.lang.String serviceName,
IDocument request,
IDocument response,
javax.resource.cci.ConnectionSpec spec)
Synchronously invoke the service with the given name, using the request and response documents given. |
java.lang.String |
invokeServiceAsync(QualifiedName appViewName,
java.lang.String appViewInstanceID,
java.lang.String serviceName,
IDocument request,
javax.resource.cci.ConnectionSpec spec)
Deprecated. This method should not be used because it assumes the response queue JNDI name is com.bea.wlai.ASYNC_RESPONSE_QUEUE, which is a distributed queue in a WebLogic cluster, thus leaving room for the possibility that the client will get associated with a different physical queue than the server puts the response on. |
java.lang.String |
invokeServiceAsync(QualifiedName appViewName,
java.lang.String appViewInstanceID,
java.lang.String serviceName,
IDocument request,
java.lang.String responseQueueJNDIName,
java.util.Map jmsPropertyMap,
javax.resource.cci.ConnectionSpec spec)
Asynchronously invoke the service with the given name, and place the response on the indicated JMS queue when the response is available. |
java.lang.String |
invokeServiceAsync(QualifiedName appViewName,
java.lang.String appViewInstanceID,
java.lang.String serviceName,
IDocument request,
java.lang.String responseQueueJNDIName,
java.util.Map jmsPropertyMap,
javax.resource.cci.ConnectionSpec spec,
java.io.Serializable userObject)
Asynchronously invoke the service with the given name, and place the response on the indicated JMS queue when the response is available. |
boolean |
isApplicationViewDeployed(QualifiedName appViewName)
Determine if this application view is deployed. |
boolean |
isAsyncEnabled(QualifiedName appViewName)
Determine if this application view has been set up to allow the user to use the invokeServiceAsync() method. |
java.lang.String[] |
listEventTypes(QualifiedName appViewName)
List the events this ApplicationView is capable of delivering, and thus the events which may be listened for using an EventContext returned from a call to getEventContext(). |
java.lang.String[] |
listServiceNames(QualifiedName appViewName)
List service names deployed for this ApplicationView. |
void |
rollbackLocalTransaction()
Rollsback a local transaction. |
Methods inherited from interface javax.ejb.EJBObject |
getEJBHome,
getHandle,
getPrimaryKey,
isIdentical,
remove |
Method Detail |
public boolean inLocalTransaction() throws java.rmi.RemoteException, javax.resource.ResourceException, javax.resource.NotSupportedException
public void beginLocalTransaction(java.lang.String strInstanceID, QualifiedName appViewName, javax.resource.cci.ConnectionSpec spec) throws java.rmi.RemoteException, javax.resource.ResourceException, javax.resource.NotSupportedException, ConnectionAcquisitionException, TransactionException
public void commitLocalTransaction() throws java.rmi.RemoteException, javax.resource.ResourceException, javax.resource.NotSupportedException, TransactionTimeoutException, TransactionException
public void rollbackLocalTransaction() throws java.rmi.RemoteException, javax.resource.ResourceException, javax.resource.NotSupportedException, TransactionTimeoutException, TransactionException
public java.lang.String[] listServiceNames(QualifiedName appViewName) throws ApplicationViewException, java.rmi.RemoteException
public java.lang.String[] listEventTypes(QualifiedName appViewName) throws ApplicationViewException, java.rmi.RemoteException
public IDocumentDefinition getRequestDocumentDefinition(QualifiedName appViewName, java.lang.String serviceName) throws ApplicationViewException, java.rmi.RemoteException
public IDocumentDefinition getResponseDocumentDefinition(QualifiedName appViewName, java.lang.String serviceName) throws ApplicationViewException, java.rmi.RemoteException
public IEventDefinition getEventDefinition(QualifiedName appViewName, java.lang.String eventType) throws ApplicationViewException, java.rmi.RemoteException
public IDocument invokeService(QualifiedName appViewName, java.lang.String serviceName, IDocument request, javax.resource.cci.ConnectionSpec spec) throws ApplicationViewException, DocumentException, javax.resource.ResourceException, TransactionTimeoutException, java.rmi.RemoteException
public IDocument invokeService(QualifiedName appViewName, java.lang.String serviceName, IDocument request, boolean autoCreateResponse, javax.resource.cci.ConnectionSpec spec) throws ApplicationViewException, DocumentException, javax.resource.ResourceException, TransactionTimeoutException, java.rmi.RemoteException
public void invokeService(QualifiedName appViewName, java.lang.String serviceName, IDocument request, IDocument response, javax.resource.cci.ConnectionSpec spec) throws ApplicationViewException, DocumentException, javax.resource.ResourceException, TransactionTimeoutException, java.rmi.RemoteException
public IDocument invokeService(QualifiedName appViewName, java.lang.String serviceName, IDocument request, boolean autoCreateResponse, javax.resource.cci.ConnectionSpec spec, boolean incAsyncCount) throws ApplicationViewException, DocumentException, javax.resource.ResourceException, TransactionTimeoutException, java.rmi.RemoteException
public IDocument invokeService(java.lang.String strInstanceID, QualifiedName appViewName, java.lang.String serviceName, IDocument request, javax.resource.cci.ConnectionSpec spec) throws ApplicationViewException, DocumentException, javax.resource.ResourceException, TransactionTimeoutException, java.rmi.RemoteException
strInstanceID
- - the ApplicationView instance ID to be used for
server side tracing per application view instancepublic IDocument invokeService(java.lang.String strInstanceID, QualifiedName appViewName, java.lang.String serviceName, IDocument request, javax.resource.cci.ConnectionSpec spec, boolean incAsyncCount) throws ApplicationViewException, DocumentException, javax.resource.ResourceException, TransactionTimeoutException, java.rmi.RemoteException
strInstanceID
- - the ApplicationView instance ID to be used for
server side tracing per application view instancepublic IDocument invokeService(java.lang.String strInstanceID, QualifiedName appViewName, java.lang.String serviceName, IDocument request, boolean autoCreateResponse, javax.resource.cci.ConnectionSpec spec) throws ApplicationViewException, DocumentException, javax.resource.ResourceException, TransactionTimeoutException, java.rmi.RemoteException
strInstanceID
- - the ApplicationView instance ID to be used for
server side tracing per application view instancepublic IDocument invokeService(java.lang.String strInstanceID, QualifiedName appViewName, java.lang.String serviceName, IDocument request, boolean autoCreateResponse, javax.resource.cci.ConnectionSpec spec, boolean incAsyncCount) throws ApplicationViewException, DocumentException, javax.resource.ResourceException, TransactionTimeoutException, java.rmi.RemoteException
strInstanceID
- - the ApplicationView instance ID to be used for
server side tracing per application view instancepublic void invokeService(java.lang.String strInstanceID, QualifiedName appViewName, java.lang.String serviceName, IDocument request, IDocument response, javax.resource.cci.ConnectionSpec spec) throws ApplicationViewException, DocumentException, javax.resource.ResourceException, TransactionTimeoutException, java.rmi.RemoteException
strInstanceID
- - the ApplicationView instance ID to be used for
server side tracing per application view instancepublic boolean isAsyncEnabled(QualifiedName appViewName) throws java.rmi.RemoteException
public java.lang.String getAsyncResponseQueueJNDIName(QualifiedName appViewName, java.lang.String strInstanceID) throws java.rmi.RemoteException
public java.lang.String invokeServiceAsync(QualifiedName appViewName, java.lang.String appViewInstanceID, java.lang.String serviceName, IDocument request, javax.resource.cci.ConnectionSpec spec) throws ApplicationViewException, java.rmi.RemoteException
public java.lang.String invokeServiceAsync(QualifiedName appViewName, java.lang.String appViewInstanceID, java.lang.String serviceName, IDocument request, java.lang.String responseQueueJNDIName, java.util.Map jmsPropertyMap, javax.resource.cci.ConnectionSpec spec) throws ApplicationViewException, java.rmi.RemoteException
Optionally, the caller can provide a map of JMS property name/value pairs. The name/value pairs must use a String for both name and value. This method will set the desired JMS properties into the async service response message that is posted to the response queue. If this feature is not required, pass jmsPropertyMap null.
The appViewInstanceID field identifies the application view instance object which made the request, and is placed into a JMS header field in the response message to allow the app view instance object to filter out just its own responses.
If errors occur during the processing of an asyncronous service request, the error message is stored into the AsyncServiceResponse object. Users should check the hasError() method of the response to determine if an error has occurred before attempting to process the response document.
The request document should conform to the document definition given by getRequestDocumentDefinition. The response document will conform to the document definition given by getResponseDocumentDefinition.
getRequestDocumentDefinition(QualifiedName,String)
,
getResponseDocumentDefinition(QualifiedName,String)
,
AsyncServiceResponse
public java.lang.String invokeServiceAsync(QualifiedName appViewName, java.lang.String appViewInstanceID, java.lang.String serviceName, IDocument request, java.lang.String responseQueueJNDIName, java.util.Map jmsPropertyMap, javax.resource.cci.ConnectionSpec spec, java.io.Serializable userObject) throws ApplicationViewException, java.rmi.RemoteException
Optionally, the caller can provide a map of JMS property name/value pairs. The name/value pairs must use a String for both name and value. This method will set the desired JMS properties into the async service response message that is posted to the response queue. If this feature is not required, pass jmsPropertyMap null.
Also optionally, the caller can provide a Serializable user object instance to propagate additionaly non-JMS context between the async request and response. Any user object passed to this call will be present on the response returned after the service invocation has been completed. This is the case even in the event of an error invoking the service. If no additional context is required, pass the user object as null.
The appViewInstanceID field identifies the application view instance object which made the request, and is placed into a JMS header field in the response message to allow the app view instance object to filter out just its own responses.
If errors occur during the processing of an asyncronous service request, the error message is stored into the AsyncServiceResponse object. Users should check the hasError() method of the response to determine if an error has occurred before attempting to process the response document.
The request document should conform to the document definition given by getRequestDocumentDefinition. The response document will conform to the document definition given by getResponseDocumentDefinition.
getRequestDocumentDefinition(QualifiedName,String)
,
getResponseDocumentDefinition(QualifiedName,String)
,
AsyncServiceResponse
public boolean isApplicationViewDeployed(QualifiedName appViewName) throws javax.naming.NamingException, java.rmi.RemoteException
public void checkEventDeployment(QualifiedName appViewName) throws DeploymentException, java.rmi.RemoteException
appViewName
- Application view on which to perform check.
|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |