com.tibco.amf.platform.runtime.extension.context
Interface CallbackContext

All Superinterfaces:
InvocationContext
All Known Subinterfaces:
MutableCallbackContext

public interface CallbackContext
extends InvocationContext

Interface that provides information on the callback.


Method Summary
 java.lang.Object getCallbackID()
          Returns the callback ID.
 long getContentLength()
          Provides the content length of the callback measured in bytes.
 javax.xml.namespace.QName getFaultName()
          Returns the qualified name of the fault if the callback message represents a fault, null otherwise.
 java.lang.String getFaultReason()
          Returns the reason of the fault if the callback message represents a fault, null otherwise.
 RequestContext getRequestContext()
          Provides the RequestContext that created this context.
 javax.security.auth.Subject getSecuritySubject()
          Provides the Subject of the callback.
 long getTimeStamp()
          Provides the the difference, measured in milliseconds, between the time when the callback was sent and midnight, January 1, 1970 UTC.
 boolean isFault()
          Returns true if the callback message represents a fault.
 
Methods inherited from interface com.tibco.amf.platform.runtime.extension.context.InvocationContext
getContextID, getCorrelationID, getInterface, getOperationName, getParameter, getParameter, getParameters, getParentContextID, getServiceName
 

Method Detail

getSecuritySubject

javax.security.auth.Subject getSecuritySubject()
Provides the Subject of the callback.

Specified by:
getSecuritySubject in interface InvocationContext
Returns:
the Subject of the callback

getCallbackID

java.lang.Object getCallbackID()
Returns the callback ID.

Returns:
the callback ID

getRequestContext

RequestContext getRequestContext()
Provides the RequestContext that created this context.

Returns:
the RequestContext that created this context
See Also:
RequestContext.createCallbackContext()

isFault

boolean isFault()
Returns true if the callback message represents a fault.

Returns:
true if the callback message represents a fault

getFaultName

javax.xml.namespace.QName getFaultName()
Returns the qualified name of the fault if the callback message represents a fault, null otherwise.

Returns:
the qualified name of the fault

getFaultReason

java.lang.String getFaultReason()
Returns the reason of the fault if the callback message represents a fault, null otherwise.

Returns:
the reason of the fault

getTimeStamp

long getTimeStamp()
Provides the the difference, measured in milliseconds, between the time when the callback was sent and midnight, January 1, 1970 UTC. Endpoints are responsible to set the time in the context.

Specified by:
getTimeStamp in interface InvocationContext
Returns:
the difference, measured in milliseconds, between the time when the callback was sent and midnight, January 1, 1970 UTC

getContentLength

long getContentLength()
Provides the content length of the callback measured in bytes. Endpoints are responsible to set the content length in the context. The content length is the number of bytes that the message occupies in its wire format.

Specified by:
getContentLength in interface InvocationContext
Returns:
the content length of the callback measured in bytes


Copyright © 2010 TIBCO Software Inc. All Rights Reserved.