com.sun.xml.ws.rx.rm.api.RmProtocolVersion Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of webservices-osgi Show documentation
Show all versions of webservices-osgi Show documentation
Metro Web Services Runtime OSGi Bundle
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.rx.rm.api;
import javax.xml.namespace.QName;
/**
* This enumeration contains all currently supported WS-ReliableMessaging versions.
*
* The choice of a WS-ReliableMessaging protocol version affects several attributes
* of Metro Reliable Messaging implementation, including the following:
*
* - FQN of WS-Policy assertions advertised in the service's WSDL
* - Namespace of Ws-ReliableMessaging protocol messages
* - Metro Reliable Messaging processing logic
*
*
* @see #WSRM200502
* @see #WSRM200702
*/
public enum RmProtocolVersion {
WSRM200502(
"http://schemas.xmlsoap.org/ws/2005/02/rm",
RmAssertionNamespace.WSRMP_200502.toString(),
"RMAssertion",
"/LastMessage"),
/**
*
* This value represents the version of WS-ReliableMessaging protocol standardized
* by OASIS organization. This is currently the most up-to-date version.
*
*
* You should primarily use this version for your WS endpoints. It is compatible with
* clients running on Metro 1.3 or .NET 3.5 and later.
*
*
* @see RmProtocolVersion
*/
WSRM200702(
"http://docs.oasis-open.org/ws-rx/wsrm/200702",
RmAssertionNamespace.WSRMP_200702.toString(),
"RMAssertion",
"/CloseSequence");
/**
* Namespaces
*/
public final String protocolNamespaceUri;
public final String policyNamespaceUri;
/**
* Action constants
*/
public final String ackRequestedAction;
public final String createSequenceAction;
public final String createSequenceResponseAction;
public final String closeSequenceAction; // == lastAction
public final String closeSequenceResponseAction;
public final String sequenceAcknowledgementAction;
public final String wsrmFaultAction;
public final String terminateSequenceAction;
public final String terminateSequenceResponseAction;
/**
* Specification assertion name
*/
public final QName rmAssertionName;
/**
* Fault codes
*/
public final QName sequenceTerminatedFaultCode;
public final QName unknownSequenceFaultCode;
public final QName invalidAcknowledgementFaultCode;
public final QName messageNumberRolloverFaultCode;
public final QName lastMessageNumberExceededFaultCode; // WS-RM 1.0 only
public final QName createSequenceRefusedFaultCode;
public final QName sequenceClosedFaultCode; // since WS-RM 1.1
public final QName wsrmRequiredFaultCode; // since WS-RM 1.1
private RmProtocolVersion(String protocolNamespaceUri, String policyNamespaceUri, String rmAssertionLocalName, String closeSequenceActionSuffix) {
this.protocolNamespaceUri = protocolNamespaceUri;
this.policyNamespaceUri = policyNamespaceUri;
this.rmAssertionName = new QName(policyNamespaceUri, rmAssertionLocalName);
this.ackRequestedAction = protocolNamespaceUri + "/AckRequested";
this.createSequenceAction = protocolNamespaceUri + "/CreateSequence";
this.createSequenceResponseAction = protocolNamespaceUri + "/CreateSequenceResponse";
this.closeSequenceAction = protocolNamespaceUri + closeSequenceActionSuffix;
this.closeSequenceResponseAction = protocolNamespaceUri + "/CloseSequenceResponse";
this.sequenceAcknowledgementAction = protocolNamespaceUri + "/SequenceAcknowledgement";
this.wsrmFaultAction = protocolNamespaceUri + "/fault";
this.terminateSequenceAction = protocolNamespaceUri + "/TerminateSequence";
this.terminateSequenceResponseAction = protocolNamespaceUri + "/TerminateSequenceResponse";
this.sequenceTerminatedFaultCode = new QName(protocolNamespaceUri, "SequenceTerminated");
this.unknownSequenceFaultCode = new QName(protocolNamespaceUri, "UnknownSequence");
this.invalidAcknowledgementFaultCode = new QName(protocolNamespaceUri, "InvalidAcknowledgement");
this.messageNumberRolloverFaultCode = new QName(protocolNamespaceUri, "MessageNumberRollover");
this.lastMessageNumberExceededFaultCode = new QName(protocolNamespaceUri, "LastMessageNumberExceeded"); // WS-RM 1.0 only
this.createSequenceRefusedFaultCode = new QName(protocolNamespaceUri, "CreateSequenceRefused");
this.sequenceClosedFaultCode = new QName(protocolNamespaceUri, "SequenceClosed"); // since WS-RM 1.1
this.wsrmRequiredFaultCode = new QName(protocolNamespaceUri, "WSRMRequired"); // since WS-RM 1.1
}
/**
* Provides a default reliable messaging version value.
*
* @return a default reliable messaging version value. Currently returns {@link #WSRM200702}.
*
* @see RmProtocolVersion
*/
public static RmProtocolVersion getDefault() {
return RmProtocolVersion.WSRM200702; // if changed, update also in ReliableMesaging annotation
}
/**
* Determines if the tested string is a valid WS-Addressing action header value
* that belongs to a WS-ReliableMessaging protocol message
*
* @param wsaAction WS-Addressing action string
*
* @return {@code true} in case the {@code wsaAction} parameter is a valid WS-Addressing
* action header value that belongs to a WS-ReliableMessaging protocol message
*/
public boolean isProtocolAction(String wsaAction) {
return (wsaAction != null) &&
(isProtocolRequest(wsaAction) ||
isProtocolResponse(wsaAction) ||
isFault(wsaAction));
}
/**
* Determines if the tested string is a valid WS-Addressing action header value
* that belongs to a WS-ReliableMessaging protocol request message
*
* @param wsaAction WS-Addressing action string
*
* @return {@code true} in case the {@code wsaAction} parameter is a valid WS-Addressing
* action header value that belongs to a WS-ReliableMessaging protocol request message
*/
public boolean isProtocolRequest(String wsaAction) {
return (wsaAction != null) &&
(ackRequestedAction.equals(wsaAction) ||
createSequenceAction.equals(wsaAction) ||
closeSequenceAction.equals(wsaAction) ||
terminateSequenceAction.equals(wsaAction));
}
/**
* Determines if the tested string is a valid WS-Addressing action header value
* that belongs to a WS-ReliableMessaging protocol response message
*
* @param wsaAction WS-Addressing action string
*
* @return {@code true} in case the {@code wsaAction} parameter is a valid WS-Addressing
* action header value that belongs to a WS-ReliableMessaging protocol response message
*/
public boolean isProtocolResponse(String wsaAction) {
return (wsaAction != null) &&
(createSequenceResponseAction.equals(wsaAction) ||
closeSequenceResponseAction.equals(wsaAction) ||
sequenceAcknowledgementAction.equals(wsaAction) ||
terminateSequenceResponseAction.equals(wsaAction));
}
/**
* Determines if the tested string is a valid WS-Addressing action header value
* that belongs to a WS-ReliableMessaging protocol fault
*
* @param wsaAction WS-Addressing action string
*
* @return {@code true} in case the {@code wsaAction} parameter is a valid WS-Addressing
* action header value that belongs to a WS-ReliableMessaging protocol fault
*/
public boolean isFault(String wsaAction) {
return wsrmFaultAction.equals(wsaAction);
}
@Override
public String toString() {
return "RmProtocolVersion" +
"{\n\tprotocolNamespaceUri=" + protocolNamespaceUri +
",\n\tpolicyNamespaceUri=" + policyNamespaceUri +
"\n}";
}
}