|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WSProceduralPushDownHelper
This interface provides helper methods that can be used by customers in their implementations of their <beanName>UserDefinedPushDownMethods classes. This sub-interface adds procedural-specific helpers beyond the generic helpers available in the super-interface.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
javax.resource.cci.MappedRecord |
createCCIMappedRecord()
This method returns an empty MappedRecord object that the caller will need to fill in with the appropriate data (which will be used by the JCA CCI interaction). |
WSStreamableRecord |
createCCIStreamableRecord()
This method returns an empty Record object that implements the CCI Streamable interface, that the caller will need to fill in with the appropriate data (which will be used by the JCA CCI interaction). |
commonj.sdo.DataObject |
createSDO(java.lang.String serviceName,
java.lang.String methodName)
This method creates a Service Data Object, to be used as input to an SCA Service method by CMP/A beans based on SCA. |
javax.resource.cci.Record |
executeCCIInteraction(java.lang.Object conn,
javax.resource.cci.InteractionSpec spec,
javax.resource.cci.Record input)
This method executes a JCA CCI interaction. |
org.apache.wsif.WSIFMessage |
executeWSIFOperation(org.apache.wsif.WSIFService service,
org.apache.wsif.WSIFMessage message,
java.lang.String operationName,
java.lang.String inputName,
java.lang.String outputName)
Deprecated. Use invokeJAXRPCCall or invokeSCAService instead |
java.lang.Object |
getEJBHome(java.lang.String ejbRefName,
java.lang.Class homeClass)
This method returns an EJB home object for the specified EJB, and is is used by CMP beans that defer their persistence to other EJBs. |
java.lang.Object |
invokeJAXRPCCall(javax.xml.rpc.Service service,
javax.xml.namespace.QName port,
javax.xml.namespace.QName operation,
javax.xml.namespace.QName returnType,
java.lang.String endpointAddress,
java.lang.Object[] params)
This method invokes a web service using JAX-RPC DII APIs. |
java.lang.Object |
invokeSCAService(java.lang.String serviceName,
java.lang.String methodName,
java.lang.Object input)
This method invokes an SCA Service synchronously using its DII APIs. |
void |
registerJAXRPCTypeMapping(javax.xml.rpc.Service service,
javax.xml.namespace.QName xmlType,
java.lang.Class javaType)
Registers custom types with the WebSphere JAX-RPC runtime. |
void |
returnCCIMappedRecord(javax.resource.cci.MappedRecord record)
This method returns the specified MappedRecord object to the cache. |
void |
returnCCIStreamableRecord(WSStreamableRecord record)
This method returns the specified Streamable Record object to the cache. |
Methods inherited from interface com.ibm.wbiserver.cmpa.WSPushDownHelper |
---|
createCCIIndexedRecord, createCCIRecord, createResourceException, createResourceException, returnCCIIndexedRecord |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
javax.resource.cci.MappedRecord createCCIMappedRecord() throws javax.resource.ResourceException
This method returns an empty MappedRecord object that the caller will need to fill in with the appropriate data (which will be used by the JCA CCI interaction).
javax.resource.ResourceException
- thrown if a MappedRecord could not be
created.void returnCCIMappedRecord(javax.resource.cci.MappedRecord record) throws javax.resource.ResourceException
This method returns the specified MappedRecord object to the cache. Use this method only if you know that this MappedRecord is no longer used and can be safely returned back to the cache and readied for future use.
record
- The CCI MappedRecord to return to the cache
javax.resource.ResourceException
- thrown if the MappedRecord could not be
returned to the cache.WSStreamableRecord createCCIStreamableRecord() throws javax.resource.ResourceException
This method returns an empty Record object that implements the CCI Streamable interface, that the caller will need to fill in with the appropriate data (which will be used by the JCA CCI interaction).
javax.resource.ResourceException
- thrown if a StreamableRecord could not be
created.void returnCCIStreamableRecord(WSStreamableRecord record) throws javax.resource.ResourceException
This method returns the specified Streamable Record object to the cache. Use this method only if you know that this Streamable Record is no longer used and can be safely returned back to the cache and readied for future use.
record
- The CCI Streamable Record to return to the cache
javax.resource.ResourceException
- thrown if the Streamable Record could not
be returned to the cache.javax.resource.cci.Record executeCCIInteraction(java.lang.Object conn, javax.resource.cci.InteractionSpec spec, javax.resource.cci.Record input) throws javax.resource.ResourceException
This method executes a JCA CCI interaction.
conn
- The connection to the JCA backend systemspec
- A CCI InteractionSpec, populated with the
information needed by the desired backendinput
- A CCI record passed as input to the JCA interaction
javax.resource.ResourceException
- Any exception raised by the interaction
with the JCA adapter will be a subclass
of ResourceException and will just be
allowed to flow back to the caller.java.lang.Object getEJBHome(java.lang.String ejbRefName, java.lang.Class homeClass) throws javax.resource.ResourceException
This method returns an EJB home object for the specified EJB, and is is used by CMP beans that defer their persistence to other EJBs.
Note that the implementation of this method caches the home object to improve performance on subsequent usage.
ejbRefName
- The name of the ejb-refhomeClass
- The class object for the desired EJB home
javax.resource.ResourceException
- thrown if ejbRefName or homeClass is nulljava.lang.Object invokeJAXRPCCall(javax.xml.rpc.Service service, javax.xml.namespace.QName port, javax.xml.namespace.QName operation, javax.xml.namespace.QName returnType, java.lang.String endpointAddress, java.lang.Object[] params) throws javax.resource.ResourceException
This method invokes a web service using JAX-RPC DII APIs. Specify null for the returnType for void operations.
service
- The JAX-RPC web serviceport
- The Qualified Name of the web service portoperation
- The Qualified Name of the web service operationreturnType
- The Qualified Name of the operation return typeendpointAddress
- The end-point address of the web service operationparams
- The parameters to the web service operation
javax.resource.ResourceException
- If any exception is encountered interacting
with the web service, it is wrapped inside
of a JCA ResourceException.void registerJAXRPCTypeMapping(javax.xml.rpc.Service service, javax.xml.namespace.QName xmlType, java.lang.Class javaType) throws javax.resource.ResourceException
Registers custom types with the WebSphere JAX-RPC runtime. All customer-defined types passed as parameters, expected as return values, or raised as exceptions by any of the web service operations used in any push-down methods of a JAX-RPC DII-based CMP/A bean should be registered via this API.
This API performs similar type mapping initialization as what would appear in the initTypeMapping of the IBM-generated SOAP binding stub for the web service. Customers using the static generated stub to invoke the web service do not need to call this API, whereas those using the Dynamic Invocation Interface (DII) to the web service do. Note that this method is not supported in a managed environment (where the Service was obtained via a java:comp lookup); in that case, an UnsupportedOperationException will be contained in the ResourceException thrown to the caller. See chapter 15 of the JAX-RPC 1.1 specification for further details.
service
- The JAX-RPC web servicexmlType
- The Qualified Name of the type being registeredjavaType
- The Java Class of the type being registered
javax.resource.ResourceException
- If any exception is encountered interacting
with the web service, it is wrapped inside
of a JCA ResourceException.org.apache.wsif.WSIFMessage executeWSIFOperation(org.apache.wsif.WSIFService service, org.apache.wsif.WSIFMessage message, java.lang.String operationName, java.lang.String inputName, java.lang.String outputName) throws javax.resource.ResourceException
This method invokes a web service using WSIF APIs.
Note that this method was primarily for users of WSAD-IE 5.1 (which had nice tooling for generating WSIF interfaces to various kinds of backend systems). WSIF has been deprecated in WebSphere 6.0, in favor of either JAX-RPC or SCA.
service
- The WSIF web servicemessage
- The WSIF message to be passed to the web serviceoperationName
- The name of the operation on the web serviceinputName
- Input name for the web service operationoutputName
- Output name for the web service operation
javax.resource.ResourceException
- If any exception is encountered interacting
with the web service, it is wrapped inside
of a JCA ResourceException.java.lang.Object invokeSCAService(java.lang.String serviceName, java.lang.String methodName, java.lang.Object input) throws javax.resource.ResourceException
This method invokes an SCA Service synchronously using its DII APIs. This version of the method expects an Object as input and returns an Object as output. Note that the input and output Objects can be SDOs, such as when the SCA Service represents a document/literal wrapped WSDL or a Java interface where the method takes multiple arguments.
serviceName
- The name used to locate the SCA Service, as specified
in the SCA .references file for this EJB jarmethodName
- The name of the method to invoke on the SCA Serviceinput
- The input to the SCA Service method
javax.resource.ResourceException
- If any exception is encountered interacting
with the SCA Service, it is wrapped inside
of a JCA ResourceException.commonj.sdo.DataObject createSDO(java.lang.String serviceName, java.lang.String methodName) throws javax.resource.ResourceException
This method creates a Service Data Object, to be used as input to an SCA Service method by CMP/A beans based on SCA.
serviceName
- The name used to locate the SCA Service, as specified
in the SCA .references file for this EJB jarmethodName
- The name of the method of the SCA Service for which
this SDO will be the input
javax.resource.ResourceException
- If any exception is encountered interacting
with the SCA runtime, it is wrapped inside
of a JCA ResourceException.
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |