com.sun.xml.ws.policy.PolicySubject Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.policy;
import com.sun.xml.ws.policy.privateutil.LocalizationMessages;
import com.sun.xml.ws.policy.privateutil.PolicyLogger;
import com.sun.xml.ws.policy.privateutil.PolicyUtils;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
/**
* A PolicySubject is an entity (e.g., a port, operation, binding,
* service) with which a policy can be associated.
*
* @author Fabian Ritzmann
*/
public final class PolicySubject {
private static final PolicyLogger LOGGER = PolicyLogger.getLogger(PolicySubject.class);
private final List policies = new LinkedList();
private final Object subject;
/**
* Constructs a policy subject instance.
*
* @param subject object to which the policies are attached. Must not be {@code null}.
* @param policy first policy attached to the subject. Must not be {@code null}.
*
* @throws IllegalArgumentException in case any of the arguments is {@code null}.
*/
public PolicySubject(Object subject, Policy policy) throws IllegalArgumentException {
if (subject == null || policy == null) {
throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0021_SUBJECT_AND_POLICY_PARAM_MUST_NOT_BE_NULL(subject, policy)));
}
this.subject = subject;
this.attach(policy);
}
/**
* Constructs a policy subject instance.
*
* @param subject object to which the policies are attached. Must not be {@code null}.
* @param policies first policy attached to the subject. Must not be {@code null}.
*
* @throws IllegalArgumentException in case any of the arguments is {@code null} or
* in case {@code policies} argument represents empty collection.
*/
public PolicySubject(Object subject, Collection policies) throws IllegalArgumentException {
if (subject == null || policies == null) {
throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0062_INPUT_PARAMS_MUST_NOT_BE_NULL()));
}
if (policies.isEmpty()) {
throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0064_INITIAL_POLICY_COLLECTION_MUST_NOT_BE_EMPTY()));
}
this.subject = subject;
this.policies.addAll(policies);
}
/**
* Attaches another Policy instance to the policy subject.
*
* @param policy new policy instance to be attached to this subject
*
* @throws IllegalArgumentException in case {@code policy} argument is {@code null}.
*/
public void attach(final Policy policy) {
if (policy == null) {
throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0038_POLICY_TO_ATTACH_MUST_NOT_BE_NULL()));
}
this.policies.add(policy);
}
/**
* Returns the effective policy of the subject, i.e. all policies of the subject
* merged together.
*
* @return effective policy of the subject
*/
public Policy getEffectivePolicy(final PolicyMerger merger) throws PolicyException {
return merger.merge(policies);
}
/**
* 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.
*/
public Object getSubject() {
return this.subject;
}
/**
* An {@code Object.toString()} method override.
*/
@Override
public String toString() {
return toString(0, new StringBuffer()).toString();
}
/**
* A helper method that appends indented string representation of this instance to the input string buffer.
*
* @param indentLevel indentation level to be used.
* @param buffer buffer to be used for appending string representation of this instance
* @return modified buffer containing new string representation of the instance
*/
StringBuffer toString(final int indentLevel, final StringBuffer buffer) {
final String indent = PolicyUtils.Text.createIndent(indentLevel);
final String innerIndent = PolicyUtils.Text.createIndent(indentLevel + 1);
buffer.append(indent).append("policy subject {").append(PolicyUtils.Text.NEW_LINE);
buffer.append(innerIndent).append("subject = '").append(subject).append('\'').append(PolicyUtils.Text.NEW_LINE);
for (Policy policy : policies) {
policy.toString(indentLevel + 1, buffer).append(PolicyUtils.Text.NEW_LINE);
}
buffer.append(indent).append('}');
return buffer;
}
}