aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.policy;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.ws.policy.privateutil.LocalizationMessages;
aoqi@0: import com.sun.xml.internal.ws.policy.privateutil.PolicyLogger;
aoqi@0: import com.sun.xml.internal.ws.policy.privateutil.PolicyUtils;
aoqi@0: import java.util.Collection;
aoqi@0: import java.util.LinkedList;
aoqi@0: import java.util.List;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * A PolicySubject is an entity (e.g., a port, operation, binding,
aoqi@0:  * service) with which a policy can be associated.
aoqi@0:  *
aoqi@0:  * @author Fabian Ritzmann
aoqi@0:  */
aoqi@0: public final class PolicySubject {
aoqi@0:     private static final PolicyLogger LOGGER = PolicyLogger.getLogger(PolicySubject.class);
aoqi@0: 
aoqi@0:     private final List<Policy> policies = new LinkedList<Policy>();
aoqi@0:     private final Object subject;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Constructs a policy subject instance.
aoqi@0:      *
aoqi@0:      * @param subject object to which the policies are attached. Must not be {@code null}.
aoqi@0:      * @param policy first policy attached to the subject. Must not be {@code null}.
aoqi@0:      *
aoqi@0:      * @throws IllegalArgumentException in case any of the arguments is {@code null}.
aoqi@0:      */
aoqi@0:     public PolicySubject(Object subject, Policy policy) throws IllegalArgumentException {
aoqi@0:         if (subject == null || policy == null) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0021_SUBJECT_AND_POLICY_PARAM_MUST_NOT_BE_NULL(subject, policy)));
aoqi@0:         }
aoqi@0: 
aoqi@0:         this.subject = subject;
aoqi@0:         this.attach(policy);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Constructs a policy subject instance.
aoqi@0:      *
aoqi@0:      * @param subject object to which the policies are attached. Must not be {@code null}.
aoqi@0:      * @param policies first policy attached to the subject. Must not be {@code null}.
aoqi@0:      *
aoqi@0:      * @throws IllegalArgumentException in case any of the arguments is {@code null} or
aoqi@0:      *         in case {@code policies} argument represents empty collection.
aoqi@0:      */
aoqi@0:     public PolicySubject(Object subject, Collection<Policy> policies) throws IllegalArgumentException {
aoqi@0:         if (subject == null || policies == null) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0062_INPUT_PARAMS_MUST_NOT_BE_NULL()));
aoqi@0:         }
aoqi@0: 
aoqi@0:         if (policies.isEmpty()) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0064_INITIAL_POLICY_COLLECTION_MUST_NOT_BE_EMPTY()));
aoqi@0:         }
aoqi@0: 
aoqi@0:         this.subject = subject;
aoqi@0:         this.policies.addAll(policies);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Attaches another Policy instance to the policy subject.
aoqi@0:      *
aoqi@0:      * @param policy new policy instance to be attached to this subject
aoqi@0:      *
aoqi@0:      * @throws IllegalArgumentException in case {@code policy} argument is {@code null}.
aoqi@0:      */
aoqi@0:     public void attach(final Policy policy) {
aoqi@0:         if (policy == null) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0038_POLICY_TO_ATTACH_MUST_NOT_BE_NULL()));
aoqi@0:         }
aoqi@0:         this.policies.add(policy);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the effective policy of the subject, i.e. all policies of the subject
aoqi@0:      * merged together.
aoqi@0:      *
aoqi@0:      * @return effective policy of the subject
aoqi@0:      */
aoqi@0:     public Policy getEffectivePolicy(final PolicyMerger merger) throws PolicyException {
aoqi@0:         return merger.merge(policies);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * A unique identifier of the subject
aoqi@0:      *
aoqi@0:      * Subjects may not always be uniquely identifiable. Also, once the subject is
aoqi@0:      * assigned to a scope, its identity may not matter anymore. Therefore this
aoqi@0:      * may be null.
aoqi@0:      */
aoqi@0:     public Object getSubject() {
aoqi@0:         return this.subject;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * An {@code Object.toString()} method override.
aoqi@0:      */
aoqi@0:     @Override
aoqi@0:     public String toString() {
aoqi@0:         return toString(0, new StringBuffer()).toString();
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * A helper method that appends indented string representation of this instance to the input string buffer.
aoqi@0:      *
aoqi@0:      * @param indentLevel indentation level to be used.
aoqi@0:      * @param buffer buffer to be used for appending string representation of this instance
aoqi@0:      * @return modified buffer containing new string representation of the instance
aoqi@0:      */
aoqi@0:     StringBuffer toString(final int indentLevel, final StringBuffer buffer) {
aoqi@0:         final String indent = PolicyUtils.Text.createIndent(indentLevel);
aoqi@0:         final String innerIndent = PolicyUtils.Text.createIndent(indentLevel + 1);
aoqi@0: 
aoqi@0:         buffer.append(indent).append("policy subject {").append(PolicyUtils.Text.NEW_LINE);
aoqi@0:         buffer.append(innerIndent).append("subject = '").append(subject).append('\'').append(PolicyUtils.Text.NEW_LINE);
aoqi@0:         for (Policy policy : policies) {
aoqi@0:             policy.toString(indentLevel + 1, buffer).append(PolicyUtils.Text.NEW_LINE);
aoqi@0:         }
aoqi@0:         buffer.append(indent).append('}');
aoqi@0: 
aoqi@0:         return buffer;
aoqi@0:     }
aoqi@0: }