Package org.jboss.as.webservices.util

Class WebMetaDataHelper

java.lang.Object

org.jboss.as.webservices.util.WebMetaDataHelper

public final class WebMetaDataHelper
extends Object

Utility class that simplifies work with JBossWebMetaData object structure.

Author:

Richard Opalka, Thomas Diesler

Method Summary

Modifier and Type	Method	Description
static List<String>	getAllRoles()	Returns all role list.
static List<org.jboss.metadata.javaee.spec.ParamValueMetaData>	getContextParams(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)	Gets context parameters meta data from jboss web meta data.
static List<String>	getHttpMethods(boolean secureWsdlAccess)	If WSDL access is secured, it returns both POST and GET methods, otherwise only POST method.
static org.jboss.metadata.web.spec.LoginConfigMetaData	getLoginConfig(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)	Gets login config meta data from jboss web meta data.
static List<org.jboss.metadata.web.spec.SecurityConstraintMetaData>	getSecurityConstraints(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)	Gets security constraints meta data from jboss web meta data.
static List<org.jboss.metadata.javaee.spec.ParamValueMetaData>	getServletInitParams(org.jboss.metadata.web.spec.ServletMetaData servletMD)	Gets init parameters meta data from servlet meta data.
static List<org.jboss.metadata.web.spec.ServletMappingMetaData>	getServletMappings(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)	Gets servlet mappings meta data from jboss web meta data.
static org.jboss.metadata.web.jboss.JBossServletsMetaData	getServlets(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)	Gets servlets meta data from jboss web meta data.
static List<String>	getUrlPatterns(String urlPattern)	Creates URL pattern list from passed string.
static org.jboss.metadata.web.spec.WebResourceCollectionsMetaData	getWebResourceCollections(org.jboss.metadata.web.spec.SecurityConstraintMetaData securityConstraintMD)	Gets web resource collections meta data from security constraint meta data.
static org.jboss.metadata.web.spec.AuthConstraintMetaData	newAuthConstraint(List<String> roleNames, org.jboss.metadata.web.spec.SecurityConstraintMetaData securityConstraintMD)	Creates new authentication constraint and associates it with security constraint meta data.
static org.jboss.metadata.javaee.spec.ParamValueMetaData	newParamValue(String key, String value, List<org.jboss.metadata.javaee.spec.ParamValueMetaData> paramsMD)	Creates new parameter meta data and associates it with parameters meta data.
static org.jboss.metadata.web.spec.SecurityConstraintMetaData	newSecurityConstraint(List<org.jboss.metadata.web.spec.SecurityConstraintMetaData> securityConstraintsMD)	Creates new security constraint meta data and associates them with security constraints meta data.
static org.jboss.metadata.web.jboss.JBossServletMetaData	newServlet(String servletName, String servletClass, org.jboss.metadata.web.jboss.JBossServletsMetaData servletsMD)	Creates new servlet meta data and associates them with servlets meta data.
static org.jboss.metadata.web.spec.ServletMappingMetaData	newServletMapping(String servletName, List<String> urlPatterns, List<org.jboss.metadata.web.spec.ServletMappingMetaData> servletMappingsMD)	Creates new servlet mapping meta data and associates them with servlet mappings meta data.
static org.jboss.metadata.web.spec.UserDataConstraintMetaData	newUserDataConstraint(String transportGuarantee, org.jboss.metadata.web.spec.SecurityConstraintMetaData securityConstraintMD)	Creates new user constraint meta data and associates it with security constraint meta data.
static org.jboss.metadata.web.spec.WebResourceCollectionMetaData	newWebResourceCollection(String servletName, String urlPattern, boolean securedWsdl, org.jboss.metadata.web.spec.WebResourceCollectionsMetaData webResourceCollectionsMD)	Creates new web resource collection meta data and associates them with web resource collections meta data.

Methods inherited from class java.lang.Object

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

Method Detail

getUrlPatterns

public static List<String> getUrlPatterns(String urlPattern)

Creates URL pattern list from passed string.

Parameters:

urlPattern - URL pattern

Returns:

list wrapping passed parameter

getHttpMethods

public static List<String> getHttpMethods(boolean secureWsdlAccess)

If WSDL access is secured, it returns both POST and GET methods, otherwise only POST method.

Parameters:

secureWsdlAccess - whether WSDL is secured

Returns:

web access methods

getAllRoles

public static List<String> getAllRoles()

Returns all role list.

Returns:

all role list

getServlets

public static org.jboss.metadata.web.jboss.JBossServletsMetaData getServlets(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)

Gets servlets meta data from jboss web meta data. If not found it creates new servlets meta data and associates them with jboss web meta data.

Parameters:

jbossWebMD - jboss web meta data

Returns:

servlets meta data

getServletMappings

public static List<org.jboss.metadata.web.spec.ServletMappingMetaData> getServletMappings(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)

Gets servlet mappings meta data from jboss web meta data. If not found it creates new servlet mappings meta data and associates them with jboss web meta data.

Parameters:

jbossWebMD - jboss web meta data

Returns:

servlet mappings meta data

getSecurityConstraints

public static List<org.jboss.metadata.web.spec.SecurityConstraintMetaData> getSecurityConstraints(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)

Gets security constraints meta data from jboss web meta data. If not found it creates new security constraints meta data and associates them with jboss web meta data.

Parameters:

jbossWebMD - jboss web meta data

Returns:

security constraints meta data

getLoginConfig

public static org.jboss.metadata.web.spec.LoginConfigMetaData getLoginConfig(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)

Gets login config meta data from jboss web meta data. If not found it creates new login config meta data and associates them with jboss web meta data.

Parameters:

jbossWebMD - jboss web meta data

Returns:

login config meta data

getContextParams

public static List<org.jboss.metadata.javaee.spec.ParamValueMetaData> getContextParams(org.jboss.metadata.web.jboss.JBossWebMetaData jbossWebMD)

Gets context parameters meta data from jboss web meta data. If not found it creates new context parameters meta data and associates them with jboss web meta data.

Parameters:

jbossWebMD - jboss web meta data

Returns:

context parameters meta data

getWebResourceCollections

public static org.jboss.metadata.web.spec.WebResourceCollectionsMetaData getWebResourceCollections(org.jboss.metadata.web.spec.SecurityConstraintMetaData securityConstraintMD)

Gets web resource collections meta data from security constraint meta data. If not found it creates new web resource collections meta data and associates them with security constraint meta data.

Parameters:

securityConstraintMD - security constraint meta data

Returns:

web resource collections meta data

getServletInitParams

public static List<org.jboss.metadata.javaee.spec.ParamValueMetaData> getServletInitParams(org.jboss.metadata.web.spec.ServletMetaData servletMD)

Gets init parameters meta data from servlet meta data. If not found it creates new init parameters meta data and associates them with servlet meta data.

Parameters:

servletMD - servlet meta data

Returns:

init parameters meta data

newSecurityConstraint

public static org.jboss.metadata.web.spec.SecurityConstraintMetaData newSecurityConstraint(List<org.jboss.metadata.web.spec.SecurityConstraintMetaData> securityConstraintsMD)

Creates new security constraint meta data and associates them with security constraints meta data.

Parameters:

securityConstraintsMD - security constraints meta data

Returns:

new security constraing meta data

newWebResourceCollection

public static org.jboss.metadata.web.spec.WebResourceCollectionMetaData newWebResourceCollection(String servletName,
                                                                                                 String urlPattern,
                                                                                                 boolean securedWsdl,
                                                                                                 org.jboss.metadata.web.spec.WebResourceCollectionsMetaData webResourceCollectionsMD)

Creates new web resource collection meta data and associates them with web resource collections meta data.

Parameters:

servletName - servlet name

urlPattern - URL pattern

securedWsdl - whether WSDL access is secured

webResourceCollectionsMD - web resource collections meta data

Returns:

new web resource collection meta data

newServlet

public static org.jboss.metadata.web.jboss.JBossServletMetaData newServlet(String servletName,
                                                                           String servletClass,
                                                                           org.jboss.metadata.web.jboss.JBossServletsMetaData servletsMD)

Creates new servlet meta data and associates them with servlets meta data.

Parameters:

servletName - servlet name

servletClass - servlet class name

servletsMD - servlets meta data

Returns:

new servlet meta data

newServletMapping

public static org.jboss.metadata.web.spec.ServletMappingMetaData newServletMapping(String servletName,
                                                                                   List<String> urlPatterns,
                                                                                   List<org.jboss.metadata.web.spec.ServletMappingMetaData> servletMappingsMD)

Creates new servlet mapping meta data and associates them with servlet mappings meta data.

Parameters:

servletName - servlet name

urlPatterns - URL patterns

servletMappingsMD - servlet mapping meta data

Returns:

new servlet mapping meta data

newAuthConstraint

public static org.jboss.metadata.web.spec.AuthConstraintMetaData newAuthConstraint(List<String> roleNames,
                                                                                   org.jboss.metadata.web.spec.SecurityConstraintMetaData securityConstraintMD)

Creates new authentication constraint and associates it with security constraint meta data.

Parameters:

roleNames - roles

securityConstraintMD - security constraint meta data

Returns:

new authentication constraint meta data

newUserDataConstraint

public static org.jboss.metadata.web.spec.UserDataConstraintMetaData newUserDataConstraint(String transportGuarantee,
                                                                                           org.jboss.metadata.web.spec.SecurityConstraintMetaData securityConstraintMD)

Creates new user constraint meta data and associates it with security constraint meta data.

Parameters:

transportGuarantee - transport guarantee value

securityConstraintMD - security constraint meta data

Returns:

new user data constraint meta data

newParamValue

public static org.jboss.metadata.javaee.spec.ParamValueMetaData newParamValue(String key,
                                                                              String value,
                                                                              List<org.jboss.metadata.javaee.spec.ParamValueMetaData> paramsMD)

Creates new parameter meta data and associates it with parameters meta data.

Parameters:

key - parameter key

value - parameter value

paramsMD - parameters meta data

Returns:

new parameter meta data