Package com.sun.xml.ws.api.config.management.policy

Class ManagementAssertion

java.lang.Object

com.sun.xml.ws.policy.PolicyAssertion

com.sun.xml.ws.policy.SimpleAssertion

com.sun.xml.ws.api.config.management.policy.ManagementAssertion

Direct Known Subclasses:

ManagedClientAssertion, ManagedServiceAssertion

public abstract class ManagementAssertion
extends SimpleAssertion

Base class for the #ManagedClientAssertion and #ManagedServiceAssertion. Provides convenience methods to directly access the policy assertion parameters.

Author:

Fabian Ritzmann

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagementAssertion.Setting	To be able to distinguish between explicit settings and no setting.

Field Summary

Fields

Modifier and Type	Field	Description
protected static QName	MANAGEMENT_ATTRIBUTE_QNAME	The name of the management attribute.
protected static QName	MONITORING_ATTRIBUTE_QNAME	The name of the monitoring attribute.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ManagementAssertion(QName name, AssertionData data, Collection<PolicyAssertion> assertionParameters)	Create a new ManagementAssertion instance.

Method Summary

Modifier and Type	Method	Description
protected static <T extends ManagementAssertion> T	getAssertion(QName name, PolicyMap policyMap, QName serviceName, QName portName, Class<T> type)	Return ManagementAssertion if one can be found in the policy map under the given service and port name.
String	getId()	Returns the value of the id attribute.
String	getStart()	Returns the value of the start attribute.
abstract boolean	isManagementEnabled()	Returns the value of the managment attribute depending on whether this is a client-side or server-side assertion.
ManagementAssertion.Setting	monitoringAttribute()	Returns the value of the monitoring attribute.

Methods inherited from class com.sun.xml.ws.policy.SimpleAssertion

getNestedPolicy, hasNestedPolicy

Methods inherited from class com.sun.xml.ws.policy.PolicyAssertion

equals, getAttributes, getAttributesSet, getAttributeValue, getImplementation, getName, getNestedAssertionsIterator, getParametersIterator, getValue, hashCode, hasNestedAssertions, hasParameters, isIgnorable, isOptional, isPrivate, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MANAGEMENT_ATTRIBUTE_QNAME

protected static final QName MANAGEMENT_ATTRIBUTE_QNAME

The name of the management attribute.

MONITORING_ATTRIBUTE_QNAME

protected static final QName MONITORING_ATTRIBUTE_QNAME

The name of the monitoring attribute.

Constructor Detail

ManagementAssertion

protected ManagementAssertion(QName name,
                              AssertionData data,
                              Collection<PolicyAssertion> assertionParameters)
                       throws AssertionCreationException

Create a new ManagementAssertion instance.

Parameters:

name - The fully qualified name of the server or client assertion. Must not be null.

data - The assertion data. Must not be null.

assertionParameters - Parameters of the assertion. May be null.

Throws:

AssertionCreationException - Thrown if the creation of the assertion failed.

Method Detail

getAssertion

protected static <T extends ManagementAssertion> T getAssertion(QName name,
                                                                PolicyMap policyMap,
                                                                QName serviceName,
                                                                QName portName,
                                                                Class<T> type)
                                                         throws jakarta.xml.ws.WebServiceException

Return ManagementAssertion if one can be found in the policy map under the given service and port name.

Type Parameters:

T - The implementation class of the assertion.

Parameters:

name - The fully qualified name of the server or client assertion.

policyMap - The policy map. May be null.

serviceName - The WSDL service name. May not be null.

portName - The WSDL port name. May not be null.

type - The implementation class of the assertion.

Returns:

An instance of ManagementAssertion or null.

Throws:

jakarta.xml.ws.WebServiceException - If computing the effective policy of the endpoint scope failed.

getId

public String getId()

Returns the value of the id attribute. May not be null.

Returns:

The value of the id attribute.

getStart

public String getStart()

Returns the value of the start attribute. May be null.

Returns:

The value of the start attribute.

isManagementEnabled

public abstract boolean isManagementEnabled()

Returns the value of the managment attribute depending on whether this is a client-side or server-side assertion.

Returns:

The value of the managment attribute.

monitoringAttribute

public ManagementAssertion.Setting monitoringAttribute()

Returns the value of the monitoring attribute.

Returns:

The value of the monitoring attribute.