Package org.apache.axis2.deployment.util

Class Utils

java.lang.Object
org.apache.axis2.deployment.util.Utils
public class Utils extends Object

  • Field Details

    • defaultEncoding

      public static String defaultEncoding

  • Constructor Details

    • Utils

      public Utils()

  • Method Details

    • addFlowHandlers

      public static void addFlowHandlers(Flow flow, ClassLoader clsLoader) throws AxisFault
      Throws:
      AxisFault

    • loadHandler

      public static boolean loadHandler(ClassLoader loader1, HandlerDescription desc) throws DeploymentException
      Throws:
      DeploymentException

    • getURLsForAllJars

      public static URL[] getURLsForAllJars(URL url, File tmpDir)

    • createTempFile

      public static File createTempFile(String suffix, InputStream in, File tmpDir) throws IOException
      Throws:
      IOException

    • getClassLoader

      public static ClassLoader getClassLoader(ClassLoader parent, String path, boolean isChildFirstClassLoading) throws DeploymentException
      Throws:
      DeploymentException

    • getClassLoader

      public static ClassLoader getClassLoader(ClassLoader parent, File file, boolean isChildFirstClassLoading) throws DeploymentException
      Get a ClassLoader which contains a classpath of a) the passed directory and b) any jar files inside the "lib/" or "Lib/" subdirectory of the passed directory.
      Parameters:
      parent - parent ClassLoader which will be the parent of the result of this method
      file - a File which must be a directory for this to be useful
      Returns:
      a new ClassLoader pointing to both the passed dir and jar files under lib/
      Throws:
      DeploymentException - if problems occur

    • fillAxisService

      public static void fillAxisService(AxisService axisService, AxisConfiguration axisConfig, ArrayList<String> excludeOperations, ArrayList<String> nonRpcMethods) throws Exception
      This guy will create a AxisService using java reflection
      Parameters:
      axisService - the target AxisService
      axisConfig - the in-scope AxisConfiguration
      excludeOperations - a List of Strings (or null), each containing a method to exclude
      nonRpcMethods - a List of Strings (or null), each containing a non-rpc method name
      Throws:
      Exception - if a problem occurs

    • getAxisOperationForJmethod

      public static AxisOperation getAxisOperationForJmethod(Method method) throws AxisFault
      Throws:
      AxisFault

    • getAxisOperationForJmethod

      public static AxisOperation getAxisOperationForJmethod(Method method, boolean isHttpSCOKforVoidMethod) throws AxisFault
      This method returns Axis operation with IN and OUT message exchange pattern for a service method which has void as the return type.

      Axis services can contain methods throws an exception and void as the return type, Normally in such case the returned Axis operation has IN only message exchange pattern. So that the http status code for the response is 202. This overloaded method added to fix that issue. This will return Axis operation with IN and OUT message exchange pattern for a service method which has void as the return type and the method must throw an checked exception. Then the response http status code will be 200 OK. To get 200 http status code you must set the mepinandout parameter to true in the axis2.xml

      Parameters:
      method - method object which represents the service method
      isHttpSCOKforVoidMethod - is httpSCOKforVoidServiceMethod parameter true or false in the axis2.xml
      Throws:
      AxisFault

    • getParameter

      public static org.apache.axiom.om.OMElement getParameter(String name, String value, boolean locked)

    • deployModuleServices

      public static void deployModuleServices(AxisModule module, ConfigurationContext configCtx) throws AxisFault
      Modules can contain services in some cases. This method will deploy all the services for a given AxisModule into the current AxisConfiguration.

      The code looks for an "aars/" directory inside the module (either .mar or exploded), and an "aars.list" file inside that to figure out which services to deploy. Note that all services deployed this way will have access to the Module's classes.

      Parameters:
      module - the AxisModule to search for services
      configCtx - ConfigurationContext in which to deploy
      Throws:
      AxisFault

    • normalize

      public static String normalize(String uri)
      Normalize a uri containing ../ and ./ paths.
      Parameters:
      uri - The uri path to normalize
      Returns:
      The normalized uri

    • getPath

      public static String getPath(String parent, String childPath)

    • findLibJars

      public static List findLibJars(URL url)
      Get names of all *.jar files inside the lib/ directory of a given jar URL
      Parameters:
      url - base URL of a JAR to search
      Returns:
      a List containing file names (Strings) of all files matching "[lL]ib/*.jar"

    • addExcludeMethods

      public static void addExcludeMethods(ArrayList<String> excludeList)
      Add the Axis2 lifecycle / session methods to a pre-existing list of names that will be excluded when generating schemas.
      Parameters:
      excludeList - an ArrayList containing method names - we'll add ours to this.

    • createClassLoader

      public static DeploymentClassLoader createClassLoader(File serviceFile, boolean isChildFirstClassLoading) throws MalformedURLException
      Throws:
      MalformedURLException

    • createClassLoader

      public static ClassLoader createClassLoader(ArrayList urls, ClassLoader serviceClassLoader, boolean extractJars, File tmpDir, boolean isChildFirstClassLoading)

    • toFile

      public static File toFile(URL url) throws UnsupportedEncodingException
      Throws:
      UnsupportedEncodingException

    • createClassLoader

      public static ClassLoader createClassLoader(URL[] urls, ClassLoader serviceClassLoader, boolean extractJars, File tmpDir, boolean isChildFirstClassLoading)

    • processBeanPropertyExclude

      public static void processBeanPropertyExclude(AxisService service)
      This method is to process bean exclude parameter and the XML format of that would be +
      Parameters:
      service - , AxisService object

    • getShortFileName

      public static String getShortFileName(String filename)

    • getAnnotatedServiceName

      public static String getAnnotatedServiceName(Class serviceClass, WebServiceAnnotation serviceAnnotation)
      The util method to prepare the JSR 181 annotated service name from given annotation or for defaults JSR 181 specifies that the in javax.jws.WebService the parameter serviceName contains the wsdl:service name to mapp. If its not available then the default will be Simple name of the class + "Service"
      Parameters:
      serviceClass - the service Class
      serviceAnnotation - a WebService annotation, or null
      Returns:
      String version of the ServiceName according to the JSR 181 spec

    • addEndpointsToService

      public static void addEndpointsToService(AxisService axisService) throws AxisFault
      Throws:
      AxisFault

    • setEndpointsToAllUsedBindings

      public static void setEndpointsToAllUsedBindings(AxisService axisService)

    • addEndpointsToService

      public static void addEndpointsToService(AxisService axisService, AxisConfiguration axisConfiguration) throws AxisFault
      Throws:
      AxisFault

    • addSoap11Endpoint

      public static void addSoap11Endpoint(AxisService axisService, String url) throws Exception
      Throws:
      Exception

    • addSoap11Endpoint

      public static void addSoap11Endpoint(AxisService axisService, String protocol, String endpointName) throws Exception
      Throws:
      Exception

    • addSoap12Endpoint

      public static void addSoap12Endpoint(AxisService axisService, String url) throws Exception
      Throws:
      Exception

    • addSoap12Endpoint

      public static void addSoap12Endpoint(AxisService axisService, String protocol, String endpointName) throws Exception
      Throws:
      Exception

    • addHttpEndpoint

      public static void addHttpEndpoint(AxisService axisService, String url)

    • addHttpEndpoint

      public static void addHttpEndpoint(AxisService axisService, String protocol, String endpointName)

    • processPolicyAttachments

      public static void processPolicyAttachments(Iterator attachmentElements, AxisService service) throws XMLStreamException, FactoryConfigurationError
      Throws:
      XMLStreamException
      FactoryConfigurationError

    • isSoap11Binding

      public static boolean isSoap11Binding(AxisBinding binding)

    • isSoap12Binding

      public static boolean isSoap12Binding(AxisBinding binding)

    • isHttpBinding

      public static boolean isHttpBinding(AxisBinding binding)

    • getSoap11Binding

      public static AxisBinding getSoap11Binding(AxisService service)

    • getSoap12Binding

      public static AxisBinding getSoap12Binding(AxisService service)

    • getHttpBinding

      public static AxisBinding getHttpBinding(AxisService service)

    • getBindingOperation

      public static AxisBindingOperation getBindingOperation(AxisBinding binding, AxisOperation operation)

    • getBindingMessage

      public static AxisBindingMessage getBindingMessage(AxisBindingOperation bindingOperation, AxisMessage message)

    • getHTTPLoacationFromServicesXML

      public static String getHTTPLoacationFromServicesXML(AxisOperation operation)
      extract the http location from services xml related to given operation
      Parameters:
      operation -
      Returns:

    • getHTTPMethodFromServicesXML

      public static String getHTTPMethodFromServicesXML(AxisOperation operation)
      extract the http method from services xml related to given operation
      Parameters:
      operation -
      Returns:

    • getHTTPInputSerializationFromServicesXML

      public static String getHTTPInputSerializationFromServicesXML(AxisOperation operation)
      get http input mime type from the services xml
      Parameters:
      operation -
      Returns:

    • getHTTPOutputSerializationFromservicesXML

      public static String getHTTPOutputSerializationFromservicesXML(AxisOperation operation)
      get http output mime type from the services xml
      Parameters:
      operation -
      Returns:

    • logFaultyServiceInfo

      public static void logFaultyServiceInfo(AxisConfiguration axisConfig)
      Log faulty services info due to unavailability of modules and transports
      Parameters:
      axisConfig -

    • getServiceHierarchy

      public static String getServiceHierarchy(String filePath, String serviceDir)
      Computes the hierarchical part of the service name if this is such a service path. Ex: filePath = .../repository/services/foo/1.0.0/version.aar -> "foo/1.0.0/" filePath = .../repository/services/version.aar -> ""
      Parameters:
      filePath - - input file path of the deploying file
      serviceDir - - 'services', 'pojo', 'servicejars' etc..
      Returns:
      hierarchical path. either "" or a '/' separated string (Ex: foo/1.0.0/)

    • formatPath

      public static String formatPath(String path)
      Format the string paths to match any platform.. windows, linux etc..
      Parameters:
      path - - input file path
      Returns:
      formatted file path

    • getClassNameFromResourceName

      public static String getClassNameFromResourceName(String resourceName)
      Get the class name from a resource name referring to a class file.
      Parameters:
      resourceName - the resource name
      Returns:
      the class name

    • getListOfClasses

      public static List<String> getListOfClasses(DeploymentFileData deploymentFileData) throws DeploymentException
      Scan a JAR file and return the list of classes contained in the JAR.
      Parameters:
      deploymentFileData - the JAR to scan
      Returns:
      a list of Java class names
      Throws:
      DeploymentException - if an error occurs while scanning the file

    • resolveOMElementChildValues

      public static void resolveOMElementChildValues(org.apache.axiom.om.OMElement element)
      Resolves env or system property values in OMElement nodes.
      Parameters:
      element - OMElement which need to resolve

    • replaceSystemProperty

      public static String replaceSystemProperty(String text)
      Replace the ${ref}, $sys{ref} and $env{ref} pattern OMText node values with env or system property values.
      Parameters:
      text - OMText node value
      Returns:
      resolved node value

    • isFatCAR

      public static boolean isFatCAR(String cAppFilePath)
      This method checks whether a given CApp file is a fat CApp or not by reading the descriptor.
      Parameters:
      cAppFilePath - CApp file path
      Returns:
      true if the CApp is a fat CApp, false otherwise