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.subject;
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 javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Provides objects for use as WSDL 1.0/1.1 policy subjects.
aoqi@0:  *
aoqi@0:  * An instance of this class may represent a wsdl:binding element or a wsdl:binding/operation
aoqi@0:  * element or a wsdl:binding/operation/message element.
aoqi@0:  *
aoqi@0:  * @author Fabian Ritzmann
aoqi@0:  */
aoqi@0: public class WsdlBindingSubject {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * For message subjects, this needs to be set to one of the values INPUT, OUTPUT
aoqi@0:      * or FAULT. Any other subject has the message type NO_MESSAGE.
aoqi@0:      */
aoqi@0:     public enum WsdlMessageType {
aoqi@0:         NO_MESSAGE,
aoqi@0:         INPUT,
aoqi@0:         OUTPUT,
aoqi@0:         FAULT
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Identifies the scope to which this subject belongs. See WS-PolicyAttachment
aoqi@0:      * for an explanation on WSDL scopes.
aoqi@0:      *
aoqi@0:      * The SERVICE scope is not actually used and only listed here for completeness
aoqi@0:      * sake.
aoqi@0:      */
aoqi@0:     public enum WsdlNameScope {
aoqi@0:         SERVICE,
aoqi@0:         ENDPOINT,
aoqi@0:         OPERATION,
aoqi@0:         MESSAGE
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static final PolicyLogger LOGGER = PolicyLogger.getLogger(WsdlBindingSubject.class);
aoqi@0: 
aoqi@0:     private final QName name;
aoqi@0:     private final WsdlMessageType messageType;
aoqi@0:     private final WsdlNameScope nameScope;
aoqi@0:     private final WsdlBindingSubject parent;
aoqi@0: 
aoqi@0:     WsdlBindingSubject(final QName name, final WsdlNameScope scope, final WsdlBindingSubject parent) {
aoqi@0:         this(name, WsdlMessageType.NO_MESSAGE, scope, parent);
aoqi@0:     }
aoqi@0: 
aoqi@0:     WsdlBindingSubject(final QName name, final WsdlMessageType messageType, final WsdlNameScope scope, final WsdlBindingSubject parent) {
aoqi@0:         this.name = name;
aoqi@0:         this.messageType = messageType;
aoqi@0:         this.nameScope = scope;
aoqi@0:         this.parent = parent;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public static WsdlBindingSubject createBindingSubject(QName bindingName) {
aoqi@0:         return new WsdlBindingSubject(bindingName, WsdlNameScope.ENDPOINT, null);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public static WsdlBindingSubject createBindingOperationSubject(QName bindingName, QName operationName) {
aoqi@0:         final WsdlBindingSubject bindingSubject = createBindingSubject(bindingName);
aoqi@0:         return new WsdlBindingSubject(operationName, WsdlNameScope.OPERATION, bindingSubject);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public static WsdlBindingSubject createBindingMessageSubject(QName bindingName, QName operationName, QName messageName, WsdlMessageType messageType) {
aoqi@0:         if (messageType == null) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0083_MESSAGE_TYPE_NULL()));
aoqi@0:         }
aoqi@0:         if (messageType == WsdlMessageType.NO_MESSAGE) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0084_MESSAGE_TYPE_NO_MESSAGE()));
aoqi@0:         }
aoqi@0:         if ((messageType == WsdlMessageType.FAULT) && (messageName == null)) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalArgumentException(LocalizationMessages.WSP_0085_MESSAGE_FAULT_NO_NAME()));
aoqi@0:         }
aoqi@0:         final WsdlBindingSubject operationSubject = createBindingOperationSubject(bindingName, operationName);
aoqi@0:         return new WsdlBindingSubject(messageName, messageType, WsdlNameScope.MESSAGE, operationSubject);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public QName getName() {
aoqi@0:         return this.name;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public WsdlMessageType getMessageType() {
aoqi@0:         return this.messageType;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public WsdlBindingSubject getParent() {
aoqi@0:         return this.parent;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public boolean isBindingSubject() {
aoqi@0:         if (this.nameScope == WsdlNameScope.ENDPOINT) {
aoqi@0:             return this.parent == null;
aoqi@0:         }
aoqi@0:         else {
aoqi@0:             return false;
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     public boolean isBindingOperationSubject() {
aoqi@0:         if (this.nameScope == WsdlNameScope.OPERATION) {
aoqi@0:             if (this.parent != null) {
aoqi@0:                 return this.parent.isBindingSubject();
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return false;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public boolean isBindingMessageSubject() {
aoqi@0:         if (this.nameScope == WsdlNameScope.MESSAGE) {
aoqi@0:             if (this.parent != null) {
aoqi@0:                 return this.parent.isBindingOperationSubject();
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return false;
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public boolean equals(final Object that) {
aoqi@0:         if (this == that) {
aoqi@0:             return true;
aoqi@0:         }
aoqi@0: 
aoqi@0:         if (that == null || !(that instanceof WsdlBindingSubject)) {
aoqi@0:             return false;
aoqi@0:         }
aoqi@0: 
aoqi@0:         final WsdlBindingSubject thatSubject = (WsdlBindingSubject) that;
aoqi@0:         boolean isEqual = true;
aoqi@0: 
aoqi@0:         isEqual = isEqual && ((this.name == null) ? thatSubject.name == null : this.name.equals(thatSubject.name));
aoqi@0:         isEqual = isEqual && this.messageType.equals(thatSubject.messageType);
aoqi@0:         isEqual = isEqual && this.nameScope.equals(thatSubject.nameScope);
aoqi@0:         isEqual = isEqual && ((this.parent == null) ? thatSubject.parent == null : this.parent.equals(thatSubject.parent));
aoqi@0: 
aoqi@0:         return isEqual;
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public int hashCode() {
aoqi@0:         int result = 23;
aoqi@0: 
aoqi@0:         result = 31 * result + ((this.name == null) ? 0 : this.name.hashCode());
aoqi@0:         result = 31 * result + this.messageType.hashCode();
aoqi@0:         result = 31 * result + this.nameScope.hashCode();
aoqi@0:         result = 31 * result + ((this.parent == null) ? 0 : this.parent.hashCode());
aoqi@0: 
aoqi@0:         return result;
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public String toString() {
aoqi@0:         final StringBuilder result = new StringBuilder("WsdlBindingSubject[");
aoqi@0:         result.append(this.name).append(", ").append(this.messageType);
aoqi@0:         result.append(", ").append(this.nameScope).append(", ").append(this.parent);
aoqi@0:         return result.append("]").toString();
aoqi@0:     }
aoqi@0: 
aoqi@0: }