Package org.apache.cxf.ws.addressing
Class ContextUtils
java.lang.Object
org.apache.cxf.ws.addressing.ContextUtils
Holder for utility methods relating to contexts.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final org.apache.cxf.ws.addressing.ObjectFactory -
Method Summary
Modifier and TypeMethodDescriptionstatic voidapplyReferenceParam(org.apache.cxf.ws.addressing.EndpointReferenceType toEpr, Object el) static DestinationcreateDecoupledDestination(Exchange exchange, org.apache.cxf.ws.addressing.EndpointReferenceType reference) static MessagecreateMessage(Exchange exchange) Create a Binding specific Message.static Stringstatic org.apache.cxf.ws.addressing.AttributedURITypegetAttributedURI(String uri) Helper method to get an attributed URI.static ConduitgetConduit(Conduit conduit, Message message) Retreive Conduit from Exchange if not already availablestatic StringgetMAPProperty(boolean isRequestor, boolean isProviderContext, boolean isOutbound) Get appropriate property name for message addressing properties.static org.apache.cxf.ws.addressing.EndpointReferenceTypestatic org.apache.cxf.ws.addressing.RelatesToTypegetRelatesTo(String uri) Helper method to get a RealtesTo instance.static booleanHelper method to determine if an MAPs Action is empty (a null action is considered empty, whereas a zero length action suppresses the propagation of the Action property).static booleanisAnonymousAddress(org.apache.cxf.ws.addressing.EndpointReferenceType ref) Helper method to determine if an EPR address is anon (either null, anonymous).static booleanDetermine if message is fault.static booleanisGenericAddress(org.apache.cxf.ws.addressing.EndpointReferenceType ref) Helper method to determine if an EPR address is generic (either null, none or anonymous).static booleanisNoneAddress(org.apache.cxf.ws.addressing.EndpointReferenceType ref) Helper method to determine if an EPR address is none.static booleanisOutbound(Message message) Determine if message is outbound.static booleanisRequestor(Message message) Determine if current messaging role is that of requestor.static voidpropogateReceivedMAPs(AddressingProperties inMAPs, Exchange exchange) Propagate inbound MAPs onto full reponse & fault messages.static voidpropogateReceivedMAPs(AddressingProperties inMAPs, Message responseMessage) Propogate inbound MAPs onto reponse message if applicable (not applicable for oneways).static booleanretrieveAsyncPostResponseDispatch(Message message) Retrieve indication that an async post-response service invocation is required.static booleanRetrieve indication that a deferred uncorrelated message abort should occur.static booleanRetrieve indication that a deferred uncorrelated message abort is supportedstatic StringretrieveMAPFaultName(Message message) Retrieve MAP fault name from the message.static StringretrieveMAPFaultReason(Message message) Retrieve MAP fault reason from the message.static AddressingPropertiesretrieveMAPs(Message message, boolean isProviderContext, boolean isOutbound) static AddressingPropertiesretrieveMAPs(Message message, boolean isProviderContext, boolean isOutbound, boolean warnIfMissing) static booleanretrievePartialResponseSent(Message message) Retrieve indication that a partial response has been sent.static voidStore indication that a deferred uncorrelated message abort should occurstatic voidStore indication that a deferred uncorrelated message abort is supportedstatic voidstoreMAPFaultName(String faultName, Message message) Store bad MAP fault name in the message.static voidstoreMAPFaultReason(String reason, Message message) Store MAP fault reason in the message.static voidstoreMAPs(AddressingProperties maps, Message message, boolean isOutbound) Store MAPs in the message.static voidstoreMAPs(AddressingProperties maps, Message message, boolean isOutbound, boolean isRequestor) Store MAPs in the message.static voidstoreMAPs(AddressingProperties maps, Message message, boolean isOutbound, boolean isRequestor, boolean isProviderContext) Store MAPs in the message.static voidstorePartialResponseSent(Message message) Store an indication that a partial response has been sent.
-
Field Details
-
WSA_OBJECT_FACTORY
public static final org.apache.cxf.ws.addressing.ObjectFactory WSA_OBJECT_FACTORY -
ACTION
-
-
Method Details
-
isOutbound
Determine if message is outbound.- Parameters:
message- the current Message- Returns:
- true iff the message direction is outbound
-
isFault
Determine if message is fault.- Parameters:
message- the current Message- Returns:
- true iff the message is a fault
-
isRequestor
Determine if current messaging role is that of requestor.- Parameters:
message- the current Message- Returns:
- true if the current messaging role is that of requestor
-
getMAPProperty
public static String getMAPProperty(boolean isRequestor, boolean isProviderContext, boolean isOutbound) Get appropriate property name for message addressing properties.- Parameters:
isRequestor- true if the current messaging role is that of requestorisProviderContext- true if the binding provider request context available to the client application as opposed to the message context visible to handlersisOutbound- true if the message is outbound- Returns:
- the property name to use when caching the MAPs in the context
-
storeMAPs
Store MAPs in the message.- Parameters:
message- the current messageisOutbound- true if the message is outbound
-
storeMAPs
public static void storeMAPs(AddressingProperties maps, Message message, boolean isOutbound, boolean isRequestor) Store MAPs in the message.- Parameters:
maps- the MAPs to storemessage- the current messageisOutbound- true if the message is outboundisRequestor- true if the current messaging role is that of requestor
-
storeMAPs
public static void storeMAPs(AddressingProperties maps, Message message, boolean isOutbound, boolean isRequestor, boolean isProviderContext) Store MAPs in the message.- Parameters:
maps- the MAPs to storemessage- the current messageisOutbound- true if the message is outboundisRequestor- true if the current messaging role is that of requestorisProviderContext- true if the binding provider request context
-
retrieveMAPs
public static AddressingProperties retrieveMAPs(Message message, boolean isProviderContext, boolean isOutbound) - Parameters:
message- the current messageisProviderContext- true if the binding provider request context available to the client application as opposed to the message context visible to handlersisOutbound- true if the message is outbound- Returns:
- the current addressing properties
-
retrieveMAPs
public static AddressingProperties retrieveMAPs(Message message, boolean isProviderContext, boolean isOutbound, boolean warnIfMissing) - Parameters:
message- the current messageisProviderContext- true if the binding provider request context available to the client application as opposed to the message context visible to handlersisOutbound- true if the message is outboundwarnIfMissing- log a warning message if properties cannot be retrieved- Returns:
- the current addressing properties
-
getAttributedURI
Helper method to get an attributed URI.- Parameters:
uri- the URI- Returns:
- an AttributedURIType encapsulating the URI
-
getRelatesTo
Helper method to get a RealtesTo instance.- Parameters:
uri- the related URI- Returns:
- a RelatesToType encapsulating the URI
-
isGenericAddress
public static boolean isGenericAddress(org.apache.cxf.ws.addressing.EndpointReferenceType ref) Helper method to determine if an EPR address is generic (either null, none or anonymous).- Parameters:
ref- the EPR under test- Returns:
- true if the address is generic
-
isAnonymousAddress
public static boolean isAnonymousAddress(org.apache.cxf.ws.addressing.EndpointReferenceType ref) Helper method to determine if an EPR address is anon (either null, anonymous).- Parameters:
ref- the EPR under test- Returns:
- true if the address is generic
-
isNoneAddress
public static boolean isNoneAddress(org.apache.cxf.ws.addressing.EndpointReferenceType ref) Helper method to determine if an EPR address is none.- Parameters:
ref- the EPR under test- Returns:
- true if the address is generic
-
hasEmptyAction
Helper method to determine if an MAPs Action is empty (a null action is considered empty, whereas a zero length action suppresses the propagation of the Action property).- Parameters:
maps- the MAPs Action under test- Returns:
- true if the Action is empty
-
propogateReceivedMAPs
Propagate inbound MAPs onto full reponse & fault messages.- Parameters:
inMAPs- the inbound MAPsexchange- the current Exchange
-
propogateReceivedMAPs
Propogate inbound MAPs onto reponse message if applicable (not applicable for oneways).- Parameters:
inMAPs- the inbound MAPsresponseMessage-
-
storeMAPFaultName
Store bad MAP fault name in the message.- Parameters:
faultName- the fault name to storemessage- the current message
-
retrieveMAPFaultName
Retrieve MAP fault name from the message.- Parameters:
message- the current message- Returns:
- the retrieved fault name
-
storeMAPFaultReason
Store MAP fault reason in the message.- Parameters:
reason- the fault reason to storemessage- the current message
-
retrieveMAPFaultReason
Retrieve MAP fault reason from the message.- Parameters:
message- the current message- Returns:
- the retrieved fault reason
-
storePartialResponseSent
Store an indication that a partial response has been sent. Relavant if *both* the replyTo & faultTo are decoupled, and a fault occurs, then we would already have sent the partial response (pre-dispatch) for the replyTo, so no need to send again.- Parameters:
message- the current message
-
retrievePartialResponseSent
Retrieve indication that a partial response has been sent.- Parameters:
message- the current message- Returns:
- the retrieved indication that a partial response has been sent
-
retrieveAsyncPostResponseDispatch
Retrieve indication that an async post-response service invocation is required.- Parameters:
message- the current message- Returns:
- the retrieved indication that an async post-response service invocation is required.
-
generateUUID
- Returns:
- a generated UUID
-
getConduit
Retreive Conduit from Exchange if not already available- Parameters:
conduit- the current value for the Conduitmessage- the current message- Returns:
- the Conduit if available
-
getNoneEndpointReference
public static org.apache.cxf.ws.addressing.EndpointReferenceType getNoneEndpointReference() -
applyReferenceParam
public static void applyReferenceParam(org.apache.cxf.ws.addressing.EndpointReferenceType toEpr, Object el) -
createMessage
Create a Binding specific Message.- Parameters:
exchange- the current exchange- Returns:
- the Method from the BindingOperationInfo
-
createDecoupledDestination
public static Destination createDecoupledDestination(Exchange exchange, org.apache.cxf.ws.addressing.EndpointReferenceType reference)
-