org.apache.axis2.addressing.metadata.ServiceName Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of axis2-kernel Show documentation
Show all versions of axis2-kernel Show documentation
Core Parts of Axis2. This includes Axis2 engine, Client API, Addressing support, etc.,
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.axis2.addressing.metadata;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMFactory;
import org.apache.axiom.om.OMNamespace;
import org.apache.axis2.AxisFault;
import org.apache.axis2.addressing.AddressingConstants;
import org.apache.axis2.addressing.AddressingConstants.Final;
import org.apache.axis2.addressing.AddressingConstants.Submission;
import javax.xml.namespace.QName;
public class ServiceName {
public static final QName subQName = new QName(Submission.WSA_NAMESPACE, AddressingConstants.EPR_SERVICE_NAME, AddressingConstants.WSA_DEFAULT_PREFIX);
public static final QName wsamQName = new QName(Final.WSAM_NAMESPACE, AddressingConstants.EPR_SERVICE_NAME, Final.WSA_DEFAULT_METADATA_PREFIX);
public static final QName wsawQName = new QName(Final.WSAW_NAMESPACE, AddressingConstants.EPR_SERVICE_NAME, Final.WSA_ORIGINAL_METADATA_PREFIX);
/**
* Field name
*/
private QName name;
/**
* Field portName
*/
private String endpointName;
/**
*
*
*/
public ServiceName() {
}
/**
* @param name
*/
public ServiceName(QName name) {
this.name = name;
}
/**
* @param name
* @param endpointName
*/
public ServiceName(QName name, String endpointName) {
this.name = name;
this.endpointName = endpointName;
}
/**
* Method getName
*/
public QName getName() {
return name;
}
/**
* Method getPortName
*/
public String getEndpointName() {
return endpointName;
}
/**
* Method setName
*
* @param name
*/
public void setName(QName name) {
this.name = name;
}
/**
* Method setPortName
*
* @param endpointName
*/
public void setEndpointName(String endpointName) {
this.endpointName = endpointName;
}
/**
* Convenience method to convert objects of this type to an {@link OMElement} so that it
* can be added to an {@link org.apache.axis2.addressing.EndpointReference}
*
* Use:
*
* OMElement omElement =
* serviceName.toOM(new QName("http://schemas.xmlsoap.org/ws/2004/08/addressing", "ServiceName", "wsa"));
*
* or
*
* OMElement omElement =
* serviceName.toOM(new QName("http://www.w3.org/2007/05/addressing/metadata", "ServiceName", "wsam"));
*
*
* the difference being whether the EndpointReference is meant to represent a 2004/08
* (Submission) or 2005/08 (Final) EndpointReference, respectively.
*
* @param factory OMFactory to use when generating OMElements
* @param qname the QName that carries the namespace of the metadata element.
*
* @return an OMElement that can be added to the metadata of an EndpointReference.
*/
public OMElement toOM(OMFactory factory, QName qname) throws AxisFault {
String localName = qname.getLocalPart();
if (!AddressingConstants.EPR_SERVICE_NAME.equals(localName)) {
throw new AxisFault("The local name must be 'ServiceName'.");
}
String prefix = qname.getPrefix();
if (prefix == null) {
throw new AxisFault("The prefix cannot be null.");
}
String namespace = qname.getNamespaceURI();
if (namespace == null) {
throw new AxisFault("The namespace canot be null.");
}
OMNamespace metadataNs = factory.createOMNamespace(namespace, prefix);
OMElement element = factory.createOMElement(localName, metadataNs);
element.setText(name);
if (endpointName != null) {
String attributeName =
Submission.WSA_NAMESPACE.equals(namespace) ?
Submission.WSA_SERVICE_NAME_ENDPOINT_NAME : Final.WSA_SERVICE_NAME_ENDPOINT_NAME;
element.addAttribute(attributeName, endpointName, null);
}
return element;
}
/**
* Convenience method to extract metadata from the ServiceName element.
*
*
* <wsam:ServiceName xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" EndpointName="...">...</wsam:ServiceName>
*
* or
*
* <wsa:ServiceName xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" PortName="...">...</wsa:ServiceName>
*
*
* @param omElement the OMElement that holds the metadata.
*/
public void fromOM(OMElement omElement) throws AxisFault {
QName qname = omElement.getQName();
String attributeName = null;
if (wsamQName.equals(qname) || wsawQName.equals(qname)) {
attributeName = Final.WSA_SERVICE_NAME_ENDPOINT_NAME;
}
else if (subQName.equals(qname)) {
attributeName = Submission.WSA_SERVICE_NAME_ENDPOINT_NAME;
}
else {
throw new AxisFault("Unrecognized element.");
}
name = omElement.getTextAsQName();
endpointName = omElement.getAttributeValue(new QName(attributeName));
}
/**
* Static method to test whether an OMElement is recognized
* as a ServiceName element. If this method returns true then
* {@link #fromOM(OMElement)} is guaranteed not to fail.
*
* @param omElement the OMElement to test.
* @return true if the element is a ServiceName element,
* false otherwise.
*/
public static boolean isServiceNameElement(OMElement omElement) {
boolean result = false;
QName qname = omElement.getQName();
if (wsamQName.equals(qname) || wsawQName.equals(qname) || subQName.equals(qname))
result = true;
return result;
}
}