RMContextUtils (Apache CXF JavaDoc 3.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Apache CXF API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.ws.rm
Class RMContextUtils

java.lang.Object
  org.apache.cxf.ws.rm.RMContextUtils

public final class RMContextUtils
extends Object
extends Object

Holder for utility methods relating to contexts.

Constructor Summary
`protected`	`RMContextUtils()` Prevents instantiation.

Method Summary
`static String`	`generateUUID()`
`static ProtocolVariation`	`getProtocolVariation(Message message)`
`static String`	`getRMPropertiesKey(boolean outbound)`
`static boolean`	`isRMProtocolMessage(String action)` Checks if the action String belongs to an RM protocol message.
`static boolean`	`isServerSide(Message message)` Determine if message is currently being processed on server side.
`static AddressingProperties`	`retrieveMAPs(Message message, boolean isProviderContext, boolean isOutbound)` Retrieves the addressing properties from the current message.
`static RMProperties`	`retrieveRMProperties(Message message, boolean outbound)` Retrieve the RM properties from the current message.
`static void`	`setProtocolVariation(Message message, ProtocolVariation protocol)`
`static void`	`storeMAPs(AddressingProperties maps, Message message, boolean isOutbound, boolean isRequestor)` Store MAPs in the message.
`static void`	`storeRMProperties(Message message, RMProperties rmps, boolean outbound)` Store the RM properties in the current message.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

RMContextUtils

protected RMContextUtils()

Prevents instantiation.

Method Detail

generateUUID

public static String generateUUID()

Returns:: a generated UUID

isServerSide

public static boolean isServerSide(Message message)

Determine if message is currently being processed on server side.

Parameters:: message - the current Message
Returns:: true if message is currently being processed on server side

isRMProtocolMessage

public static boolean isRMProtocolMessage(String action)

Checks if the action String belongs to an RM protocol message.

Parameters:: action - the action
Returns:: true if the action is not one of the RM protocol actions.

retrieveRMProperties

public static RMProperties retrieveRMProperties(Message message,
                                                boolean outbound)

Retrieve the RM properties from the current message.

Parameters:: message - the current message; outbound - true if the message direction is outbound
Returns:: the RM properties

storeRMProperties

public static void storeRMProperties(Message message,
                                     RMProperties rmps,
                                     boolean outbound)

Store the RM properties in the current message.

Parameters:: message - the current message; rmps - the RM properties; outbound - if the message direction is outbound

retrieveMAPs

public static AddressingProperties retrieveMAPs(Message message,
                                                boolean isProviderContext,
                                                boolean isOutbound)

Retrieves the addressing properties from the current message.

Parameters:: message - the current message; isProviderContext - true if the binding provider request context available to the client application as opposed to the message context visible to handlers; isOutbound - true if the message is outbound
Returns:: the current addressing properties

storeMAPs

public static void storeMAPs(AddressingProperties maps,
                             Message message,
                             boolean isOutbound,
                             boolean isRequestor)

Store MAPs in the message.

Parameters:: maps - the MAPs to store; message - the current message; isOutbound - true if the message is outbound; isRequestor - true if the current messaging role is that of requestor; handler - true if HANDLER scope, APPLICATION scope otherwise

getRMPropertiesKey

public static String getRMPropertiesKey(boolean outbound)

getProtocolVariation

public static ProtocolVariation getProtocolVariation(Message message)

setProtocolVariation

public static void setProtocolVariation(Message message,
                                        ProtocolVariation protocol)