com.sun.xml.ws.policy.sourcemodel

Class PolicySourceModel

java.lang.Object

com.sun.xml.ws.policy.sourcemodel.PolicySourceModel

All Implemented Interfaces:

java.lang.Cloneable

public class PolicySourceModel
extends java.lang.Object
implements java.lang.Cloneable

This class is a root of unmarshaled policy source structure. Each instance of the class contains factory method to create new ModelNode instances associated with the actual model instance.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.String,java.lang.String>	DEFAULT_NAMESPACE_TO_PREFIX
private boolean	expanded
private static PolicyLogger	LOGGER
private java.util.Map<java.lang.String,java.lang.String>	namespaceToPrefix
private NamespaceVersion	nsVersion
private java.lang.String	policyId
private java.lang.String	policyName
private java.util.List<ModelNode>	references
private ModelNode	rootNode

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PolicySourceModel(NamespaceVersion nsVersion) Constructor that creates a new policy source model instance without any id or name identifier.
private	PolicySourceModel(NamespaceVersion nsVersion, java.lang.String policyId, java.lang.String policyName) Constructor that creates a new policy source model instance with given id or name identifier.
protected	PolicySourceModel(NamespaceVersion nsVersion, java.lang.String policyId, java.lang.String policyName, java.util.Collection<PrefixMapper> prefixMappers) Constructor that creates a new policy source model instance with given id or name identifier and a set of PrefixMappers.

Method Summary

Modifier and Type	Method and Description
(package private) void	addNewPolicyReference(ModelNode node) Adds new policy reference to the policy source model.
protected PolicySourceModel	clone()
boolean	containsPolicyReferences() Returns a boolean value indicating whether this policy source model contains references to another policy source models.
static PolicySourceModel	createPolicySourceModel(NamespaceVersion nsVersion) Factory method that creates new policy source model instance.
static PolicySourceModel	createPolicySourceModel(NamespaceVersion nsVersion, java.lang.String policyId, java.lang.String policyName) Factory method that creates new policy source model instance and initializes it according to parameters provided.
boolean	equals(java.lang.Object obj) An Object.equals(Object obj) method override.
void	expand(PolicySourceModelContext context) Expands current policy model.
private java.lang.String	getDefaultPrefix(java.lang.String namespace) Method retrieves default prefix for given namespace.
(package private) java.util.Map<java.lang.String,java.lang.String>	getNamespaceToPrefixMapping() Provides information about how namespaces used in this PolicySourceModel instance should be mapped to their default prefixes when marshalled.
NamespaceVersion	getNamespaceVersion() Returns an original namespace version of this policy source model.
java.lang.String	getPolicyId() Returns a policy ID of this policy source model.
java.lang.String	getPolicyName() Returns a policy name of this policy source model.
ModelNode	getRootNode() Returns a root node of this policy source model.
private java.util.Collection<java.lang.String>	getUsedNamespaces() Iterates through policy vocabulary and extracts set of namespaces used in the policy expression.
int	hashCode() An Object.hashCode() method override.
private boolean	isExpanded() Returns a boolean value indicating whether this policy source model contains is already expanded (i.e.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final PolicyLogger LOGGER

DEFAULT_NAMESPACE_TO_PREFIX

private static final java.util.Map<java.lang.String,java.lang.String> DEFAULT_NAMESPACE_TO_PREFIX

namespaceToPrefix

private final java.util.Map<java.lang.String,java.lang.String> namespaceToPrefix

rootNode

private ModelNode rootNode

policyId

private final java.lang.String policyId

policyName

private final java.lang.String policyName

nsVersion

private final NamespaceVersion nsVersion

references

private final java.util.List<ModelNode> references

expanded

private boolean expanded

Constructor Detail

PolicySourceModel

private PolicySourceModel(NamespaceVersion nsVersion)

Constructor that creates a new policy source model instance without any id or name identifier. The namespace-to-prefix map is initialized with mapping of policy namespace to the default value set by POLICY_NAMESPACE_PREFIX constant.

Parameters:

nsVersion - The WS-Policy version.

PolicySourceModel

private PolicySourceModel(NamespaceVersion nsVersion,
                          java.lang.String policyId,
                          java.lang.String policyName)

Constructor that creates a new policy source model instance with given id or name identifier.

Parameters:

nsVersion - The WS-Policy version.

policyId - Relative policy reference within an XML document. May be null.

policyName - Absolute IRI of policy expression. May be null.

PolicySourceModel

protected PolicySourceModel(NamespaceVersion nsVersion,
                            java.lang.String policyId,
                            java.lang.String policyName,
                            java.util.Collection<PrefixMapper> prefixMappers)

Constructor that creates a new policy source model instance with given id or name identifier and a set of PrefixMappers. This constructor is intended to be used by the JAX-WS com.sun.xml.ws.policy.api.SourceModel.

Parameters:

nsVersion - The WS-Policy version.

policyId - Relative policy reference within an XML document. May be null.

policyName - Absolute IRI of policy expression. May be null.

prefixMappers - A collection of PrefixMappers to be used with this instance. May be null.

Method Detail

createPolicySourceModel

public static PolicySourceModel createPolicySourceModel(NamespaceVersion nsVersion)

Factory method that creates new policy source model instance. This method is only intended to be used by code that has no dependencies on JAX-WS. Otherwise use com.sun.xml.ws.policy.api.SourceModel.

Parameters:

nsVersion - The policy version

Returns:

Newly created policy source model instance.

createPolicySourceModel

public static PolicySourceModel createPolicySourceModel(NamespaceVersion nsVersion,
                                                        java.lang.String policyId,
                                                        java.lang.String policyName)

Factory method that creates new policy source model instance and initializes it according to parameters provided. This method is only intended to be used by code that has no dependencies on JAX-WS. Otherwise use com.sun.xml.ws.policy.api.SourceModel.

Parameters:

nsVersion - The policy version

policyId - local policy identifier - relative URI. May be null.

policyName - global policy identifier - absolute policy expression URI. May be null.

Returns:

Newly created policy source model instance with its name and id properly set.

getRootNode

public ModelNode getRootNode()

Returns a root node of this policy source model. It is allways of POLICY type.

Returns:

root policy source model node - allways of POLICY type.

getPolicyName

public java.lang.String getPolicyName()

Returns a policy name of this policy source model.

Returns:

policy name.

getPolicyId

public java.lang.String getPolicyId()

Returns a policy ID of this policy source model.

Returns:

policy ID.

getNamespaceVersion

public NamespaceVersion getNamespaceVersion()

Returns an original namespace version of this policy source model.

Returns:

namespace version.

getNamespaceToPrefixMapping

java.util.Map<java.lang.String,java.lang.String> getNamespaceToPrefixMapping()
                                                                      throws PolicyException

Provides information about how namespaces used in this PolicySourceModel instance should be mapped to their default prefixes when marshalled.

Returns:

immutable map that holds information about namespaces used in the model and their mapping to prefixes that should be used when marshalling this model.

Throws:

PolicyException - Thrown if one of the prefix mappers threw an exception.

equals

public boolean equals(java.lang.Object obj)

An Object.equals(Object obj) method override.

When child nodes are tested for equality, the parent policy source model is not considered. Thus two different policy source models instances may be equal based on their node content.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

An Object.hashCode() method override.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

clone

protected PolicySourceModel clone()
                           throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

containsPolicyReferences

public boolean containsPolicyReferences()

Returns a boolean value indicating whether this policy source model contains references to another policy source models.

Every source model that references other policies must be expanded before it can be translated into a Policy objects. See expand(PolicySourceModelContext) and isExpanded() for more details.

Returns:

true or {code false} depending on whether this policy source model contains references to another policy source models.

isExpanded

private boolean isExpanded()

Returns a boolean value indicating whether this policy source model contains is already expanded (i.e. contains no unexpanded policy references) or not. This means that if model does not originally contain any policy references, it is considered as expanded, thus this method returns true in such case. Also this method does not check whether the references policy source models are expanded as well, so after expanding this model a value of true is returned even if referenced models are not expanded yet. Thus each model can be considered to be fully expanded only if all policy source models stored in PolicySourceModelContext instance are expanded, provided the PolicySourceModelContext instance contains full set of policy source models.

Every source model that references other policies must be expanded before it can be translated into a Policy object. See expand(PolicySourceModelContext) and containsPolicyReferences() for more details.

Returns:

true or false depending on whether this policy source model contains is expanded or not.

expand

public void expand(PolicySourceModelContext context)
            throws PolicyException

Expands current policy model. This means, that if this model contains any (unexpanded) policy references, then the method expands those references by placing the content of the referenced policy source models under the policy reference nodes. This operation merely creates a link between this and referenced policy source models. Thus any change in the referenced models will be visible wihtin this model as well.

Please, notice that the method does not check if the referenced models are already expanded nor does the method try to expand unexpanded referenced models. This must be preformed manually within client's code. Consecutive calls of this method will have no effect.

Every source model that references other policies must be expanded before it can be translated into a Policy object. See isExpanded() and containsPolicyReferences() for more details.

Parameters:

context - a policy source model context holding the set of unmarshalled policy source models within the same context.

Throws:

PolicyException - Thrown if a referenced policy could not be resolved

addNewPolicyReference

void addNewPolicyReference(ModelNode node)

Adds new policy reference to the policy source model. The method is used by the ModelNode instances of type POLICY_REFERENCE that need to register themselves as policy references in the model.

Parameters:

node - policy reference model node to be registered as a policy reference in this model.

getUsedNamespaces

private java.util.Collection<java.lang.String> getUsedNamespaces()
                                                          throws PolicyException

Iterates through policy vocabulary and extracts set of namespaces used in the policy expression.

Returns:

collection of used namespaces within given policy instance

Throws:

PolicyException - Thrown if internal processing failed.

getDefaultPrefix

private java.lang.String getDefaultPrefix(java.lang.String namespace)

Method retrieves default prefix for given namespace. Method returns null if no default prefix is defined..

Parameters:

namespace - to get default prefix for.

Returns:

default prefix for given namespace. May return null if the default prefix for given namespace is not defined.