com.sun.xml.ws.policy

Class PolicySubject

java.lang.Object

com.sun.xml.ws.policy.PolicySubject

public final class PolicySubject
extends java.lang.Object

A PolicySubject is an entity (e.g., a port, operation, binding, service) with which a policy can be associated.

Field Summary

Fields

Modifier and Type	Field and Description
private static PolicyLogger	LOGGER
private java.util.List<Policy>	policies
private java.lang.Object	subject

Constructor Summary

Constructors

Constructor and Description
PolicySubject(java.lang.Object subject, java.util.Collection<Policy> policies) Constructs a policy subject instance.
PolicySubject(java.lang.Object subject, Policy policy) Constructs a policy subject instance.

Method Summary

Modifier and Type	Method and Description
void	attach(Policy policy) Attaches another Policy instance to the policy subject.
Policy	getEffectivePolicy(PolicyMerger merger) Returns the effective policy of the subject, i.e.
java.lang.Object	getSubject() A unique identifier of the subject Subjects may not always be uniquely identifiable.
java.lang.String	toString() An Object.toString() method override.
(package private) java.lang.StringBuffer	toString(int indentLevel, java.lang.StringBuffer buffer) A helper method that appends indented string representation of this instance to the input string buffer.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final PolicyLogger LOGGER

policies

private final java.util.List<Policy> policies

subject

private final java.lang.Object subject

Constructor Detail

PolicySubject

public PolicySubject(java.lang.Object subject,
                     Policy policy)
              throws java.lang.IllegalArgumentException

Constructs a policy subject instance.

Parameters:

subject - object to which the policies are attached. Must not be null.

policy - first policy attached to the subject. Must not be null.

Throws:

java.lang.IllegalArgumentException - in case any of the arguments is null.

PolicySubject

public PolicySubject(java.lang.Object subject,
                     java.util.Collection<Policy> policies)
              throws java.lang.IllegalArgumentException

Constructs a policy subject instance.

Parameters:

subject - object to which the policies are attached. Must not be null.

policies - first policy attached to the subject. Must not be null.

Throws:

java.lang.IllegalArgumentException - in case any of the arguments is null or in case policies argument represents empty collection.

Method Detail

attach

public void attach(Policy policy)

Attaches another Policy instance to the policy subject.

Parameters:

policy - new policy instance to be attached to this subject

Throws:

java.lang.IllegalArgumentException - in case policy argument is null.

getEffectivePolicy

public Policy getEffectivePolicy(PolicyMerger merger)
                          throws PolicyException

Returns the effective policy of the subject, i.e. all policies of the subject merged together.

Returns:

effective policy of the subject

Throws:

PolicyException

getSubject

public java.lang.Object getSubject()

A unique identifier of the subject Subjects may not always be uniquely identifiable. Also, once the subject is assigned to a scope, its identity may not matter anymore. Therefore this may be null.

toString

public java.lang.String toString()

An Object.toString() method override.

Overrides:

toString in class java.lang.Object

toString

java.lang.StringBuffer toString(int indentLevel,
                                java.lang.StringBuffer buffer)

A helper method that appends indented string representation of this instance to the input string buffer.

Parameters:

indentLevel - indentation level to be used.

buffer - buffer to be used for appending string representation of this instance

Returns:

modified buffer containing new string representation of the instance