org.apache.cxf.transport.http.policy
Class PolicyUtils

java.lang.Object
  org.apache.cxf.transport.http.policy.PolicyUtils

public final class PolicyUtils
extends Object

Field Summary

static QName	HTTPCLIENTPOLICY_ASSERTION_QNAME
static String	HTTPCONF_NAMESPACE
static QName	HTTPSERVERPOLICY_ASSERTION_QNAME

Method Summary

static void	assertClientPolicy(Message message, HTTPClientPolicy client) Asserts all HTTPClientPolicy assertions that are compatible with the specified client policy.
static void	assertServerPolicy(Message message, HTTPServerPolicy server) Asserts all HTTPServerPolicy assertions that are equal to the specified server policy.
static boolean	compatible(HTTPClientPolicy p1, HTTPClientPolicy p2) Checks if two HTTPClientPolicy objects are compatible.
static boolean	compatible(HTTPServerPolicy p1, HTTPServerPolicy p2) Checks if two HTTPServerPolicy objects are compatible.
static boolean	equals(HTTPClientPolicy p1, HTTPClientPolicy p2) Determines if two HTTPClientPolicy objects are equal.
static boolean	equals(HTTPServerPolicy p1, HTTPServerPolicy p2) Determines if two HTTPServerPolicy objects are equal.
static HTTPClientPolicy	getClient(Message message, HTTPClientPolicy confPolicy) Returns a HTTPClientPolicy that is compatible with the assertions included in the service, endpoint, operation and message policy subjects AND the HTTPClientPolicy passed as a second argument.
static HTTPClientPolicy	getClient(PolicyEngine pe, EndpointInfo ei, Conduit c) Returns a HTTPClientPolicy that is compatible with the assertions included in the service and endpoint policy subjects, or null if there are no such assertions.
static HTTPServerPolicy	getServer(Message message, HTTPServerPolicy confPolicy) Returns a HTTPServerPolicy that is compatible with the assertions included in the service, endpoint, operation and message policy subjects AND the HTTPServerPolicy passed as a second argument.
static HTTPServerPolicy	getServer(PolicyEngine pe, EndpointInfo ei, Destination d) Returns a HTTPServerPolicy that is compatible with the assertions included in the service and endpoint policy subjects, or null if there are no such assertions.
static HTTPClientPolicy	intersect(HTTPClientPolicy p1, HTTPClientPolicy p2) Returns a new HTTPClientPolicy that is compatible with the two specified policies or null if no compatible policy can be determined.
static HTTPServerPolicy	intersect(HTTPServerPolicy p1, HTTPServerPolicy p2) Returns a new HTTPServerPolicy that is compatible with the two specified policies or null if no compatible policy can be determined.
static String	toString(HTTPClientPolicy p)
static String	toString(HTTPServerPolicy p)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTTPCONF_NAMESPACE

public static final String HTTPCONF_NAMESPACE

See Also:

Constant Field Values

HTTPCLIENTPOLICY_ASSERTION_QNAME

public static final QName HTTPCLIENTPOLICY_ASSERTION_QNAME

HTTPSERVERPOLICY_ASSERTION_QNAME

public static final QName HTTPSERVERPOLICY_ASSERTION_QNAME

Method Detail

getClient

public static HTTPClientPolicy getClient(Message message,
                                         HTTPClientPolicy confPolicy)

Returns a HTTPClientPolicy that is compatible with the assertions included in the service, endpoint, operation and message policy subjects AND the HTTPClientPolicy passed as a second argument.

Parameters:

message - the message

confPolicy - the additional policy to be compatible with

Returns:

the HTTPClientPolicy for the message

Throws:

PolicyException - if no compatible HTTPClientPolicy can be determined

getServer

public static HTTPServerPolicy getServer(Message message,
                                         HTTPServerPolicy confPolicy)

Returns a HTTPServerPolicy that is compatible with the assertions included in the service, endpoint, operation and message policy subjects AND the HTTPServerPolicy passed as a second argument.

Parameters:

message - the message

confPolicy - the additional policy to be compatible with

Returns:

the HTTPServerPolicy for the message

Throws:

PolicyException - if no compatible HTTPServerPolicy can be determined

getClient

public static HTTPClientPolicy getClient(PolicyEngine pe,
                                         EndpointInfo ei,
                                         Conduit c)

Returns a HTTPClientPolicy that is compatible with the assertions included in the service and endpoint policy subjects, or null if there are no such assertions.

Parameters:

pe - the policy engine

ei - the endpoint info

c - the conduit

Returns:

the compatible policy

Throws:

PolicyException - if no compatible HTTPClientPolicy can be determined

getServer

public static HTTPServerPolicy getServer(PolicyEngine pe,
                                         EndpointInfo ei,
                                         Destination d)

Returns a HTTPServerPolicy that is compatible with the assertions included in the service and endpoint policy subjects, or null if there are no such assertions.

Parameters:

pe - the policy engine

ei - the endpoint info

d - the destination

Returns:

the compatible policy

Throws:

PolicyException - if no compatible HTTPServerPolicy can be determined

assertClientPolicy

public static void assertClientPolicy(Message message,
                                      HTTPClientPolicy client)

Asserts all HTTPClientPolicy assertions that are compatible with the specified client policy.

Parameters:

message - the current message

client - the client policy

assertServerPolicy

public static void assertServerPolicy(Message message,
                                      HTTPServerPolicy server)

Asserts all HTTPServerPolicy assertions that are equal to the specified server policy.

Parameters:

message - the current message

server - the server policy

compatible

public static boolean compatible(HTTPClientPolicy p1,
                                 HTTPClientPolicy p2)

Checks if two HTTPClientPolicy objects are compatible.

Parameters:

p1 - one client policy

p2 - another client policy

Returns:

true iff policies are compatible

intersect

public static HTTPClientPolicy intersect(HTTPClientPolicy p1,
                                         HTTPClientPolicy p2)

Returns a new HTTPClientPolicy that is compatible with the two specified policies or null if no compatible policy can be determined.

Parameters:

p1 - one policy

p2 - another policy

Returns:

the compatible policy

equals

public static boolean equals(HTTPClientPolicy p1,
                             HTTPClientPolicy p2)

Determines if two HTTPClientPolicy objects are equal. REVISIT: Check if this can be replaced by a generated equals method.

Parameters:

p1 - one client policy

p2 - another client policy

Returns:

true iff the two policies are equal

compatible

public static boolean compatible(HTTPServerPolicy p1,
                                 HTTPServerPolicy p2)

Checks if two HTTPServerPolicy objects are compatible.

Parameters:

p1 - one server policy

p2 - another server policy

Returns:

true iff policies are compatible

intersect

public static HTTPServerPolicy intersect(HTTPServerPolicy p1,
                                         HTTPServerPolicy p2)

Returns a new HTTPServerPolicy that is compatible with the two specified policies or null if no compatible policy can be determined.

Parameters:

p1 - one policy

p2 - another policy

Returns:

the compatible policy

equals

public static boolean equals(HTTPServerPolicy p1,
                             HTTPServerPolicy p2)

Determines if two HTTPServerPolicy objects are equal. REVISIT: Check if this can be replaced by a generated equals method.

Parameters:

p1 - one server policy

p2 - another server policy

Returns:

true iff the two policies are equal

toString

public static String toString(HTTPClientPolicy p)

toString

public static String toString(HTTPServerPolicy p)