| java.lang.Object
 com.sun.xml.ws.policy.jaxws.PolicyConfigParser
| PolicyConfigParser | | final public class PolicyConfigParser (Code) | | Reads a policy configuration file and returns the WSDL model generated from it.
author:
Marek Potociar (marek.potociar at sun.com) |
| Method Summary | |
| public static PolicyMap | extractPolicyMap(WSDLModel model)
Utility method that tries to retrieve a
PolicyMap object from a given
WSDLModel . | | public static PolicyMap | parse(String configFileIdentifier, Container container, PolicyMapMutator... mutators)
This is a helper method that returns directly
PolicyMap instance populated
from information in WSIT config file. | | public static PolicyMap | parse(URL configFileUrl, boolean isClient, PolicyMapMutator... mutators)
This is a helper method that returns directly
PolicyMap instance populated
from information in WSIT config file. | | public static WSDLModel | parseModel(String configFileIdentifier, Container container, PolicyMapMutator... mutators)
The function 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. | | public static WSDLModel | parseModel(URL configFileUrl, boolean isClient, PolicyMapMutator... mutators)
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. |
| extractPolicyMap | | public static PolicyMap extractPolicyMap(WSDLModel model)(Code) | | Utility method that tries to retrieve a
PolicyMap object from a given
WSDLModel . When succesfull,
PolicyMap instance is returned,
otherwise result is
null .
Parameters:
model - A WSDLModel (possibly) with a PolicyMap objectpopulated with information read from the WSIT config file. May be null ;in that case, null is returned as a result of this function call. PolicyMap instance retrieved from a given WSDLModelif successful, null otherwise. |
| parse | | public static PolicyMap parse(String configFileIdentifier, Container container, PolicyMapMutator... mutators) throws PolicyException(Code) | | 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
PolicyConfigParser.parseModel(String,Container,PolicyMapMutator[]) parseModel method.
Parameters:
configFileIdentifier - base of WSIT config file name (web service name for WSIT serviceconfig file or "client" for WSIT client configuration). Must not be null .
Parameters:
container - if the application is run inside a web container, the container instanceshould be passed into this function, in order to get access to the servlet contextthat is used to load config file stored in WEB-INF directory of the application.May be null .
Parameters:
mutators - to be registered with the populated PolicyMap object. May beommited if user does not plan to modify the PolicyMap instance. A WSDLModel with a PolicyMap object populated with information readfrom the WSIT config file.
throws:
PolicyException - in case of any problems that may occur while reading WSIT config fileand constructing the WSDLModel object or populating PolicyMap instance. |
| parseModel | | public static WSDLModel parseModel(String configFileIdentifier, Container container, PolicyMapMutator... mutators) throws PolicyException(Code) | | The function 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, warning
message is logged and
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 serviceconfig file or "client" for WSIT client configuration). Must not be null .
Parameters:
container - if the application is run inside a web container, the container instanceshould be passed into this function, in order to get access to the servlet contextthat is used to load config file stored in WEB-INF directory of the application.May be null .
Parameters:
mutators - to be registered with the populated PolicyMap object. May beommited if user does not plan to modify the PolicyMap instance. A WSDLModel with a PolicyMap object populated with information readfrom the WSIT config file.
throws:
PolicyException - in case of any problems that may occur while reading WSIT config fileand constructing the WSDLModel object or populating PolicyMap instance. |
| parseModel | | public static WSDLModel parseModel(URL configFileUrl, boolean isClient, PolicyMapMutator... mutators) throws PolicyException, IllegalArgumentException(Code) | | 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 .
Parameters:
isClient - must be true if this method is invoked to parse client configuration, false otherwise
Parameters:
mutators - to be registered with the populated PolicyMap object. May beommited if user does not plan to modify the PolicyMap instance. A WSDLModel with a PolicyMap object populated with information readfrom the WSIT config file.
throws:
PolicyException - in case of any problems that may occur while reading WSIT config fileand constructing the WSDLModel object or populating PolicyMap instance.
throws:
IllegalArgumentException - in case configFileUrl parameter is null . |
|
|