src/share/jaxws_classes/com/sun/xml/internal/ws/policy/PolicySubject.java

Thu, 12 Oct 2017 19:44:07 +0800

author
aoqi
date
Thu, 12 Oct 2017 19:44:07 +0800
changeset 760
e530533619ec
parent 0
373ffda63c9a
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.xml.internal.ws.policy;
aoqi@0 27
aoqi@0 28 import com.sun.xml.internal.ws.policy.privateutil.LocalizationMessages;
aoqi@0 29 import com.sun.xml.internal.ws.policy.privateutil.PolicyLogger;
aoqi@0 30 import com.sun.xml.internal.ws.policy.privateutil.PolicyUtils;
aoqi@0 31 import java.util.Collection;
aoqi@0 32 import java.util.LinkedList;
aoqi@0 33 import java.util.List;
aoqi@0 34
aoqi@0 35 /**
aoqi@0 36 * A PolicySubject is an entity (e.g., a port, operation, binding,
aoqi@0 37 * service) with which a policy can be associated.
aoqi@0 38 *
aoqi@0 39 * @author Fabian Ritzmann
aoqi@0 40 */
aoqi@0 41 public final class PolicySubject {
aoqi@0 42 private static final PolicyLogger LOGGER = PolicyLogger.getLogger(PolicySubject.class);
aoqi@0 43
aoqi@0 44 private final List<Policy> policies = new LinkedList<Policy>();
aoqi@0 45 private final Object subject;
aoqi@0 46
aoqi@0 47 /**
aoqi@0 48 * Constructs a policy subject instance.
aoqi@0 49 *
aoqi@0 50 * @param subject object to which the policies are attached. Must not be {@code null}.
aoqi@0 51 * @param policy first policy attached to the subject. Must not be {@code null}.
aoqi@0 52 *
aoqi@0 53 * @throws IllegalArgumentException in case any of the arguments is {@code null}.
aoqi@0 54 */
aoqi@0 55 public PolicySubject(Object subject, Policy policy) throws IllegalArgumentException {
aoqi@0 56 if (subject == null || policy == null) {
aoqi@0 57 throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0021_SUBJECT_AND_POLICY_PARAM_MUST_NOT_BE_NULL(subject, policy)));
aoqi@0 58 }
aoqi@0 59
aoqi@0 60 this.subject = subject;
aoqi@0 61 this.attach(policy);
aoqi@0 62 }
aoqi@0 63
aoqi@0 64 /**
aoqi@0 65 * Constructs a policy subject instance.
aoqi@0 66 *
aoqi@0 67 * @param subject object to which the policies are attached. Must not be {@code null}.
aoqi@0 68 * @param policies first policy attached to the subject. Must not be {@code null}.
aoqi@0 69 *
aoqi@0 70 * @throws IllegalArgumentException in case any of the arguments is {@code null} or
aoqi@0 71 * in case {@code policies} argument represents empty collection.
aoqi@0 72 */
aoqi@0 73 public PolicySubject(Object subject, Collection<Policy> policies) throws IllegalArgumentException {
aoqi@0 74 if (subject == null || policies == null) {
aoqi@0 75 throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0062_INPUT_PARAMS_MUST_NOT_BE_NULL()));
aoqi@0 76 }
aoqi@0 77
aoqi@0 78 if (policies.isEmpty()) {
aoqi@0 79 throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0064_INITIAL_POLICY_COLLECTION_MUST_NOT_BE_EMPTY()));
aoqi@0 80 }
aoqi@0 81
aoqi@0 82 this.subject = subject;
aoqi@0 83 this.policies.addAll(policies);
aoqi@0 84 }
aoqi@0 85
aoqi@0 86 /**
aoqi@0 87 * Attaches another Policy instance to the policy subject.
aoqi@0 88 *
aoqi@0 89 * @param policy new policy instance to be attached to this subject
aoqi@0 90 *
aoqi@0 91 * @throws IllegalArgumentException in case {@code policy} argument is {@code null}.
aoqi@0 92 */
aoqi@0 93 public void attach(final Policy policy) {
aoqi@0 94 if (policy == null) {
aoqi@0 95 throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0038_POLICY_TO_ATTACH_MUST_NOT_BE_NULL()));
aoqi@0 96 }
aoqi@0 97 this.policies.add(policy);
aoqi@0 98 }
aoqi@0 99
aoqi@0 100 /**
aoqi@0 101 * Returns the effective policy of the subject, i.e. all policies of the subject
aoqi@0 102 * merged together.
aoqi@0 103 *
aoqi@0 104 * @return effective policy of the subject
aoqi@0 105 */
aoqi@0 106 public Policy getEffectivePolicy(final PolicyMerger merger) throws PolicyException {
aoqi@0 107 return merger.merge(policies);
aoqi@0 108 }
aoqi@0 109
aoqi@0 110 /**
aoqi@0 111 * A unique identifier of the subject
aoqi@0 112 *
aoqi@0 113 * Subjects may not always be uniquely identifiable. Also, once the subject is
aoqi@0 114 * assigned to a scope, its identity may not matter anymore. Therefore this
aoqi@0 115 * may be null.
aoqi@0 116 */
aoqi@0 117 public Object getSubject() {
aoqi@0 118 return this.subject;
aoqi@0 119 }
aoqi@0 120
aoqi@0 121 /**
aoqi@0 122 * An {@code Object.toString()} method override.
aoqi@0 123 */
aoqi@0 124 @Override
aoqi@0 125 public String toString() {
aoqi@0 126 return toString(0, new StringBuffer()).toString();
aoqi@0 127 }
aoqi@0 128
aoqi@0 129 /**
aoqi@0 130 * A helper method that appends indented string representation of this instance to the input string buffer.
aoqi@0 131 *
aoqi@0 132 * @param indentLevel indentation level to be used.
aoqi@0 133 * @param buffer buffer to be used for appending string representation of this instance
aoqi@0 134 * @return modified buffer containing new string representation of the instance
aoqi@0 135 */
aoqi@0 136 StringBuffer toString(final int indentLevel, final StringBuffer buffer) {
aoqi@0 137 final String indent = PolicyUtils.Text.createIndent(indentLevel);
aoqi@0 138 final String innerIndent = PolicyUtils.Text.createIndent(indentLevel + 1);
aoqi@0 139
aoqi@0 140 buffer.append(indent).append("policy subject {").append(PolicyUtils.Text.NEW_LINE);
aoqi@0 141 buffer.append(innerIndent).append("subject = '").append(subject).append('\'').append(PolicyUtils.Text.NEW_LINE);
aoqi@0 142 for (Policy policy : policies) {
aoqi@0 143 policy.toString(indentLevel + 1, buffer).append(PolicyUtils.Text.NEW_LINE);
aoqi@0 144 }
aoqi@0 145 buffer.append(indent).append('}');
aoqi@0 146
aoqi@0 147 return buffer;
aoqi@0 148 }
aoqi@0 149 }

mercurial