Module org.glassfish.metro.wsit.impl
Package com.sun.xml.ws.policy.parser

Class PolicyConfigParser

java.lang.Object
com.sun.xml.ws.policy.parser.PolicyConfigParser
public final class PolicyConfigParser extends Object
Reads a policy configuration file and returns the WSDL model generated from it.
Author:
Fabian Ritzmann, Marek Potociar (marek.potociar at sun.com)

  • Method Summary

    Modifier and Type
    Method
    Description
    static URL
    findConfigFile(String configFileIdentifier, com.sun.xml.ws.api.server.Container container)
    Find a WSIT config file based on the configFileIdentifier parameter according to following pattern:
    static com.sun.xml.ws.policy.PolicyMap
    parse(String configFileIdentifier, com.sun.xml.ws.api.server.Container container, com.sun.xml.ws.policy.PolicyMapMutator... mutators)
    This is a helper method that returns directly PolicyMap instance populated from information in WSIT config file.
    static com.sun.xml.ws.policy.PolicyMap
    parse(URL configFileUrl, boolean isClient, com.sun.xml.ws.policy.PolicyMapMutator... mutators)
    This is a helper method that returns directly PolicyMap instance populated from information in WSIT config file.
    static com.sun.xml.ws.api.model.wsdl.WSDLModel
    parseModel(String configFileIdentifier, com.sun.xml.ws.api.server.Container container, com.sun.xml.ws.policy.PolicyMapMutator... mutators)
    The method uses configFileIdentifier parameter to construct a WSIT config file name according to following pattern:
    static com.sun.xml.ws.api.model.wsdl.WSDLModel
    parseModel(URL configFileUrl, boolean isClient, com.sun.xml.ws.policy.PolicyMapMutator... mutators)
    Reads the WSIT config from a file denoted by configFileUrl parameter.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • parse

      public static com.sun.xml.ws.policy.PolicyMap parse(String configFileIdentifier, com.sun.xml.ws.api.server.Container container, com.sun.xml.ws.policy.PolicyMapMutator... mutators) throws com.sun.xml.ws.policy.PolicyException
      This is a helper method that returns directly PolicyMap instance populated from information in WSIT config file. For more details on the whole process see parseModel method.
      Parameters:
      configFileIdentifier - base of WSIT config file name (web service name for WSIT service config file or "client" for WSIT client configuration). Must not be null.
      container - if the application is run inside a web container, the container instance should be passed into this function, in order to get access to the servlet context that is used to load config file stored in WEB-INF directory of the application. May be null.
      mutators - to be registered with the populated PolicyMap object. May be ommited if user does not plan to modify the PolicyMap instance.
      Returns:
      A WSDLModel with a PolicyMap object populated with information read from the WSIT config file.
      Throws:
      com.sun.xml.ws.policy.PolicyException - in case of any problems that may occur while reading WSIT config file and constructing the WSDLModel object or populating PolicyMap instance.

    • parse

      public static com.sun.xml.ws.policy.PolicyMap parse(URL configFileUrl, boolean isClient, com.sun.xml.ws.policy.PolicyMapMutator... mutators) throws com.sun.xml.ws.policy.PolicyException, IllegalArgumentException
      This is a helper method that returns directly PolicyMap instance populated from information in WSIT config file. For more details on the whole process see parseModel method.
      Parameters:
      configFileUrl - URL of the config file resource that should be parsed. Must not be null.
      isClient - must be true if this method is invoked to parse client configuration, false otherwise
      mutators - to be registered with the populated PolicyMap object. May be ommited if user does not plan to modify the PolicyMap instance.
      Returns:
      A WSDLModel with a PolicyMap object populated with information read from the WSIT config file.
      Throws:
      com.sun.xml.ws.policy.PolicyException - in case of any problems that may occur while reading WSIT config file and constructing the WSDLModel object or populating PolicyMap instance.
      IllegalArgumentException - in case configFileUrl parameter is null.

    • parseModel

      public static com.sun.xml.ws.api.model.wsdl.WSDLModel parseModel(String configFileIdentifier, com.sun.xml.ws.api.server.Container container, com.sun.xml.ws.policy.PolicyMapMutator... mutators) throws com.sun.xml.ws.policy.PolicyException
      The method uses configFileIdentifier parameter to construct a WSIT config file name according to following pattern:

      wsit-[configFileIdentifier].xml

      After constructing the WSIT config file name, the function tries to find the WSIT config file and read it from the following locations:

      • WEB-INF - for servlet-based web service implementations
      • META-INF - for EJB-based web service implementations
      • classpath - for web service clients
      If the file is found it is parsed and resulting WSDLModel object containig the populated PolicyMap instance is returned. If config file is not found, null is returned as a result of this function call. In case of any other problems that may occur while reading the WSIT config file, a PolicyException is thrown.

      Since PolicyMap object is immutable as such, this function gives you also a chance to register your own PolicyMapMutator objects so that you are able to modify the PolicyMap object later if needed.

      Parameters:
      configFileIdentifier - base of WSIT config file name (web service name for WSIT service config file or "client" for WSIT client configuration). Must not be null.
      container - if the application is run inside a web container, the container instance should be passed into this function, in order to get access to the servlet context that is used to load config file stored in WEB-INF directory of the application. May be null.
      mutators - to be registered with the populated PolicyMap object. May be ommited if user does not plan to modify the PolicyMap instance.
      Returns:
      A WSDLModel with a PolicyMap object populated with information read from the WSIT config file.
      Throws:
      com.sun.xml.ws.policy.PolicyException - in case of any problems that may occur while reading WSIT config file and constructing the WSDLModel object or populating PolicyMap instance.

    • parseModel

      public static com.sun.xml.ws.api.model.wsdl.WSDLModel parseModel(URL configFileUrl, boolean isClient, com.sun.xml.ws.policy.PolicyMapMutator... mutators) throws com.sun.xml.ws.policy.PolicyException, IllegalArgumentException
      Reads the WSIT config from a file denoted by configFileUrl parameter. If the file exists it is parsed and resulting WSDLModel object containig the populated PolicyMap instance is returned. If config file for given URL does not exist or in case of any other problems that may occur while reading the WSIT config file, a PolicyException is thrown.
      Parameters:
      configFileUrl - URL of the config file resource that should be parsed. Must not be null.
      isClient - must be true if this method is invoked to parse client configuration, false otherwise
      mutators - to be registered with the populated PolicyMap object. May be ommited if user does not plan to modify the PolicyMap instance.
      Returns:
      A WSDLModel with a PolicyMap object populated with information read from the WSIT config file.
      Throws:
      com.sun.xml.ws.policy.PolicyException - in case of any problems that may occur while reading WSIT config file and constructing the WSDLModel object or populating PolicyMap instance.
      IllegalArgumentException - in case configFileUrl parameter is null.

    • findConfigFile

      public static URL findConfigFile(String configFileIdentifier, com.sun.xml.ws.api.server.Container container) throws com.sun.xml.ws.policy.PolicyException
      Find a WSIT config file based on the configFileIdentifier parameter according to following pattern:

      wsit-[configFileIdentifier].xml

      After constructing the WSIT config file name, the function tries to find the WSIT config file in the following locations:

      • WEB-INF - for servlet-based web service implementations
      • META-INF - for EJB-based web service implementations
      • classpath - for web service clients
      If the file is found it is parsed and the resulting WSDLModel object containig the populated PolicyMap instance is returned. If config file is not found, null is returned as a result of this method call. In case of any other problems that may occur while locating the WSIT config file, a PolicyException is thrown.
      Parameters:
      configFileIdentifier - base of WSIT config file name (web service name for WSIT service config file or "client" for WSIT client configuration). Must not be null.
      container - if the application is run inside a web container, the container instance should be passed into this function, in order to get access to the servlet context that is used to load config file stored in WEB-INF directory of the application. May be null.
      Returns:
      A URL pointing to the WSIT configuration file. Null if not found.
      Throws:
      com.sun.xml.ws.policy.PolicyException - in case of any problems that may occur while locating the WSIT config file.