Package org.apache.axis2.util
Class Utils
java.lang.Object
org.apache.axis2.util.Utils
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidaddHandler(Flow flow, Handler handler, String phaseName) static voidcalculateDefaultModuleVersion(HashMap modules, AxisConfiguration axisConfig) static booleancheckVersion(Version module1version, Version module2version) - if he trying to engage the same module then method will returen false - else it will return truestatic ObjectcreateServiceObject(AxisService service) Create a service object for a given service.static AxisServicecreateSimpleInOnlyService(QName serviceName, MessageReceiver messageReceiver, QName opName) static AxisServicecreateSimpleService(QName serviceName, String className, QName opName) static AxisServicecreateSimpleService(QName serviceName, MessageReceiver messageReceiver, String className, QName opName) static AxisServicecreateSimpleServiceforClient(QName serviceName, String className, QName opName) static AxisServicecreateSimpleServiceforClient(QName serviceName, MessageReceiver messageReceiver, String className, QName opName) static ServiceContextfillContextInformation(AxisService axisService, ConfigurationContext configurationContext) static intgetAxisSpecifMEPConstant(String messageExchangePattern) Maps the String URI of the Message exchange pattern to a integer.static StringgetHostname(AxisConfiguration axisConfiguration) First check whether the hostname parameter is there in AxisConfiguration (axis2.xml) , if it is there then this will return that as the host name , o.w will return the IP address.static AxisFaultgetInboundFaultFromMessageContext(MessageContext messageContext) Get an AxisFault object to represent the SOAPFault in the SOAPEnvelope attached to the provided MessageContext.static StringReturns the ip address to be used for the replyto epr CAUTION: This will go through all the available network interfaces and will try to return an ip address.static StringgetIpAddress(AxisConfiguration axisConfiguration) First check whether the hostname parameter is there in AxisConfiguration (axis2.xml) , if it is there then this will retun that as the host name , o.w will return the IP address.static StringgetModuleName(String moduleName, String moduleVersion) static intgetMtomThreshold(MessageContext msgCtxt) static ConfigurationContextgetNewConfigurationContext(String repositry) static ClassLoadergetObjectClassLoader(Object object) This method will provide the logic needed to retrieve an Object's classloader in a Java 2 Security compliant manner.static StringgetOperationName(String path, String serviceName) Compute the operation path from request URI using the servince name.static StringgetParameterValue(Parameter param) static StringgetServiceAndOperationPart(String path, String servicePath) Gives the service/operation part from the incoming EPR Ex: ..services/foo/bar/Version/getVersion -> foo/bar/Version/getVersionstatic Class<?>getServiceClass(AxisService service) Get the service class for a given service.static StringgetURIScheme(String uri) Get the scheme part from a URI (or URL).static booleanisClientThreadNonBlockingPropertySet(MessageContext messageContext) this is to make is backward compatible.static booleanisHiddenService(AxisService axisService) This method is used to find whether an axis2service is declared as hidden using the "hiddenService" paramstatic booleanisValidModuleName(String moduleName) static String[]parseRequestURLForServiceAndOperation(String path, String servicePath) Break a full path into piecesstatic StringsanitizeWebOutput(String text)
-
Constructor Details
-
Utils
public Utils()
-
-
Method Details
-
addHandler
-
createSimpleService
public static AxisService createSimpleService(QName serviceName, String className, QName opName) throws AxisFault - Throws:
AxisFault
-
createSimpleServiceforClient
public static AxisService createSimpleServiceforClient(QName serviceName, String className, QName opName) throws AxisFault - Throws:
AxisFault
-
createSimpleInOnlyService
public static AxisService createSimpleInOnlyService(QName serviceName, MessageReceiver messageReceiver, QName opName) throws AxisFault - Throws:
AxisFault
-
createSimpleService
public static AxisService createSimpleService(QName serviceName, MessageReceiver messageReceiver, String className, QName opName) throws AxisFault - Throws:
AxisFault
-
createSimpleServiceforClient
public static AxisService createSimpleServiceforClient(QName serviceName, MessageReceiver messageReceiver, String className, QName opName) throws AxisFault - Throws:
AxisFault
-
fillContextInformation
public static ServiceContext fillContextInformation(AxisService axisService, ConfigurationContext configurationContext) throws AxisFault - Throws:
AxisFault
-
parseRequestURLForServiceAndOperation
Break a full path into pieces- Returns:
- an array where element [0] always contains the service, and element 1, if not null, contains the path after the first element. all ? parameters are discarded.
-
getServiceAndOperationPart
Gives the service/operation part from the incoming EPR Ex: ..services/foo/bar/Version/getVersion -> foo/bar/Version/getVersion- Parameters:
path- - incoming EPRservicePath- - Ex: 'services'- Returns:
- - service/operation part
-
getOperationName
Compute the operation path from request URI using the servince name. Service name can be a normal one or a hierarchical one. Ex: ../services/Echo/echoString -> echoString ../services/foo/1.0.0/Echo/echoString -> echoString ../services/Echo/ -> null- Parameters:
path- - request URIserviceName- - service name- Returns:
- - operation name if any, else null
-
getNewConfigurationContext
- Throws:
Exception
-
getParameterValue
-
getModuleName
-
isValidModuleName
-
checkVersion
- if he trying to engage the same module then method will returen false - else it will return true- Throws:
AxisFault
-
calculateDefaultModuleVersion
-
getAxisSpecifMEPConstant
Maps the String URI of the Message exchange pattern to a integer. Further, in the first lookup, it will cache the looked up value so that the subsequent method calls are extremely efficient. -
getInboundFaultFromMessageContext
Get an AxisFault object to represent the SOAPFault in the SOAPEnvelope attached to the provided MessageContext. This first check for an already extracted AxisFault and otherwise does a simple extract. MUST NOT be passed a MessageContext which does not contain a SOAPFault- Parameters:
messageContext-- Returns:
-
getObjectClassLoader
This method will provide the logic needed to retrieve an Object's classloader in a Java 2 Security compliant manner. -
getMtomThreshold
-
getIpAddress
Returns the ip address to be used for the replyto epr CAUTION: This will go through all the available network interfaces and will try to return an ip address. First this will try to get the first IP which is not loopback address (127.0.0.1). If none is found then this will return this will return 127.0.0.1. This will not consider IPv6 addresses. TODO: - Improve this logic to genaralize it a bit more - Obtain the ip to be used here from the Call API- Returns:
- Returns String.
- Throws:
SocketException
-
getIpAddress
First check whether the hostname parameter is there in AxisConfiguration (axis2.xml) , if it is there then this will retun that as the host name , o.w will return the IP address.- Throws:
SocketException
-
getHostname
First check whether the hostname parameter is there in AxisConfiguration (axis2.xml) , if it is there then this will return that as the host name , o.w will return the IP address.- Parameters:
axisConfiguration-- Returns:
- hostname
-
getURIScheme
Get the scheme part from a URI (or URL).- Parameters:
uri- the URI- Returns:
- the scheme of the URI
-
sanitizeWebOutput
-
createServiceObject
Create a service object for a given service. The method first looks for theConstants.SERVICE_OBJECT_SUPPLIERservice parameter and if this parameter is present, it will use the specified class to create the service object. If the parameter is not present, it will create an instance of the class specified by theConstants.SERVICE_CLASSparameter.- Parameters:
service- the service- Returns:
- The service object or
nullif neither theConstants.SERVICE_OBJECT_SUPPLIERnor theConstants.SERVICE_CLASSparameter was found on the service, i.e. if the service doesn't specify how to create a service object. If the return value is non null, it will always be a newly created instance. - Throws:
AxisFault- if an error occurred while attempting to instantiate the service object
-
getServiceClass
Get the service class for a given service. This method will first check theConstants.SERVICE_CLASSservice parameter and if that parameter is not present, inspect the instance returned by the service object supplier specified byConstants.SERVICE_OBJECT_SUPPLIER.- Parameters:
service- the service- Returns:
- The service class or
nullif neither theConstants.SERVICE_CLASSnor theConstants.SERVICE_OBJECT_SUPPLIERparameter was found on the service, i.e. if the service doesn't specify a service class. - Throws:
AxisFault- if an error occurred while attempting to load the service class or to instantiate the service object
-
isClientThreadNonBlockingPropertySet
this is to make is backward compatible. Get rid of this at the next major release.- Parameters:
messageContext-- Returns:
-
isHiddenService
This method is used to find whether an axis2service is declared as hidden using the "hiddenService" param- Parameters:
axisService- - the service of interest- Returns:
- true if is declared as hidden, false if not
-