< prev index next >
src/java.xml.ws/share/classes/javax/xml/ws/handler/MessageContext.java
Print this page
*** 25,67 ****
package javax.xml.ws.handler;
import java.util.Map;
/**
! * The interface <code>MessageContext</code> abstracts the message
! * context that is processed by a handler in the <code>handle</code>
* method.
*
! * <p>The <code>MessageContext</code> interface provides methods to
! * manage a property set. <code>MessageContext</code> properties
* enable handlers in a handler chain to share processing related
* state.
*
* @since 1.6, JAX-WS 2.0
*/
public interface MessageContext extends Map<String, Object> {
/**
! * Standard property: message direction, <code>true</code> for
! * outbound messages, <code>false</code> for inbound.
* <p>Type: boolean
*/
public static final String MESSAGE_OUTBOUND_PROPERTY =
"javax.xml.ws.handler.message.outbound";
/**
* Standard property: Map of attachments to a message for the inbound
* message, key is the MIME Content-ID, value is a DataHandler.
! * <p>Type: java.util.Map<String,DataHandler>
*/
public static final String INBOUND_MESSAGE_ATTACHMENTS =
"javax.xml.ws.binding.attachments.inbound";
/**
* Standard property: Map of attachments to a message for the outbound
* message, key is the MIME Content-ID, value is a DataHandler.
! * <p>Type: java.util.Map<String,DataHandler>
*/
public static final String OUTBOUND_MESSAGE_ATTACHMENTS =
"javax.xml.ws.binding.attachments.outbound";
/**
--- 25,67 ----
package javax.xml.ws.handler;
import java.util.Map;
/**
! * The interface {@code MessageContext} abstracts the message
! * context that is processed by a handler in the {@code handle}
* method.
*
! * <p>The {@code MessageContext} interface provides methods to
! * manage a property set. {@code MessageContext} properties
* enable handlers in a handler chain to share processing related
* state.
*
* @since 1.6, JAX-WS 2.0
*/
public interface MessageContext extends Map<String, Object> {
/**
! * Standard property: message direction, {@code true} for
! * outbound messages, {@code false} for inbound.
* <p>Type: boolean
*/
public static final String MESSAGE_OUTBOUND_PROPERTY =
"javax.xml.ws.handler.message.outbound";
/**
* Standard property: Map of attachments to a message for the inbound
* message, key is the MIME Content-ID, value is a DataHandler.
! * <p>Type: {@code java.util.Map<String, DataHandler>}
*/
public static final String INBOUND_MESSAGE_ATTACHMENTS =
"javax.xml.ws.binding.attachments.inbound";
/**
* Standard property: Map of attachments to a message for the outbound
* message, key is the MIME Content-ID, value is a DataHandler.
! * <p>Type: {@code java.util.Map<String, DataHandler>}
*/
public static final String OUTBOUND_MESSAGE_ATTACHMENTS =
"javax.xml.ws.binding.attachments.outbound";
/**
*** 106,123 ****
public static final String HTTP_RESPONSE_CODE =
"javax.xml.ws.http.response.code";
/**
* Standard property: HTTP request headers.
! * <p>Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>>
*/
public static final String HTTP_REQUEST_HEADERS =
"javax.xml.ws.http.request.headers";
/**
* Standard property: HTTP response headers.
! * <p>Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>>
*/
public static final String HTTP_RESPONSE_HEADERS =
"javax.xml.ws.http.response.headers";
/**
--- 106,123 ----
public static final String HTTP_RESPONSE_CODE =
"javax.xml.ws.http.response.code";
/**
* Standard property: HTTP request headers.
! * <p>Type: {@code java.util.Map<java.lang.String, java.util.List<java.lang.String>>}
*/
public static final String HTTP_REQUEST_HEADERS =
"javax.xml.ws.http.request.headers";
/**
* Standard property: HTTP response headers.
! * <p>Type: {@code java.util.Map<java.lang.String, java.util.List<java.lang.String>>}
*/
public static final String HTTP_RESPONSE_HEADERS =
"javax.xml.ws.http.response.headers";
/**
*** 164,194 ****
/**
* Standard property: WS Addressing Reference Parameters.
* The list MUST include all SOAP headers marked with the
* wsa:IsReferenceParameter="true" attribute.
! * <p>Type: List<Element>
*
* @since 1.6, JAX-WS 2.1
*/
public static final String REFERENCE_PARAMETERS =
"javax.xml.ws.reference.parameters";
/**
! * Property scope. Properties scoped as <code>APPLICATION</code> are
* visible to handlers,
* client applications and service endpoints; properties scoped as
! * <code>HANDLER</code>
* are only normally visible to handlers.
*/
public enum Scope {APPLICATION, HANDLER};
/**
* Sets the scope of a property.
*
* @param name Name of the property associated with the
! * <code>MessageContext</code>
* @param scope Desired scope of the property
* @throws java.lang.IllegalArgumentException if an illegal
* property name is specified
*/
public void setScope(String name, Scope scope);
--- 164,194 ----
/**
* Standard property: WS Addressing Reference Parameters.
* The list MUST include all SOAP headers marked with the
* wsa:IsReferenceParameter="true" attribute.
! * <p>Type: {@code List<Element>}
*
* @since 1.6, JAX-WS 2.1
*/
public static final String REFERENCE_PARAMETERS =
"javax.xml.ws.reference.parameters";
/**
! * Property scope. Properties scoped as {@code APPLICATION} are
* visible to handlers,
* client applications and service endpoints; properties scoped as
! * {@code HANDLER}
* are only normally visible to handlers.
*/
public enum Scope {APPLICATION, HANDLER};
/**
* Sets the scope of a property.
*
* @param name Name of the property associated with the
! * {@code MessageContext}
* @param scope Desired scope of the property
* @throws java.lang.IllegalArgumentException if an illegal
* property name is specified
*/
public void setScope(String name, Scope scope);
< prev index next >