< prev index next >

jaxws/src/java.xml.ws/share/classes/javax/xml/ws/handler/MessageContext.java

Print this page


   1 /*
   2  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


 163             "javax.xml.ws.http.request.pathinfo";
 164 
 165     /**
 166      * Standard property: WS Addressing Reference Parameters.
 167      * The list MUST include all SOAP headers marked with the
 168      * wsa:IsReferenceParameter="true" attribute.
 169      * <p>Type: {@code List<Element>}
 170      *
 171      * @since 1.6, JAX-WS 2.1
 172      */
 173     public static final String REFERENCE_PARAMETERS =
 174             "javax.xml.ws.reference.parameters";
 175 
 176     /**
 177      * Property scope. Properties scoped as {@code APPLICATION} are
 178      * visible to handlers,
 179      * client applications and service endpoints; properties scoped as
 180      * {@code HANDLER}
 181      * are only normally visible to handlers.
 182      */
 183     public enum Scope {APPLICATION, HANDLER};










 184 
 185     /**
 186      * Sets the scope of a property.
 187      *
 188      * @param name Name of the property associated with the
 189      *             {@code MessageContext}
 190      * @param scope Desired scope of the property
 191      * @throws java.lang.IllegalArgumentException if an illegal
 192      *             property name is specified
 193      */
 194     public void setScope(String name,  Scope scope);
 195 
 196     /**
 197      * Gets the scope of a property.
 198      *
 199      * @param name Name of the property
 200      * @return Scope of the property
 201      * @throws java.lang.IllegalArgumentException if a non-existant
 202      *             property name is specified
 203      */
   1 /*
   2  * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


 163             "javax.xml.ws.http.request.pathinfo";
 164 
 165     /**
 166      * Standard property: WS Addressing Reference Parameters.
 167      * The list MUST include all SOAP headers marked with the
 168      * wsa:IsReferenceParameter="true" attribute.
 169      * <p>Type: {@code List<Element>}
 170      *
 171      * @since 1.6, JAX-WS 2.1
 172      */
 173     public static final String REFERENCE_PARAMETERS =
 174             "javax.xml.ws.reference.parameters";
 175 
 176     /**
 177      * Property scope. Properties scoped as {@code APPLICATION} are
 178      * visible to handlers,
 179      * client applications and service endpoints; properties scoped as
 180      * {@code HANDLER}
 181      * are only normally visible to handlers.
 182      */
 183     public enum Scope {
 184 
 185         /**
 186          * Application visibility.
 187          */
 188         APPLICATION,
 189 
 190         /**
 191          * Handler visibility.
 192          */
 193         HANDLER};
 194 
 195     /**
 196      * Sets the scope of a property.
 197      *
 198      * @param name Name of the property associated with the
 199      *             {@code MessageContext}
 200      * @param scope Desired scope of the property
 201      * @throws java.lang.IllegalArgumentException if an illegal
 202      *             property name is specified
 203      */
 204     public void setScope(String name,  Scope scope);
 205 
 206     /**
 207      * Gets the scope of a property.
 208      *
 209      * @param name Name of the property
 210      * @return Scope of the property
 211      * @throws java.lang.IllegalArgumentException if a non-existant
 212      *             property name is specified
 213      */
< prev index next >