com.ibm.ws.rest.services.admin
Class WBIRestServicesHelper

java.lang.Object
  extended by com.ibm.ws.rest.services.admin.WBIRestServicesHelper

public class WBIRestServicesHelper
extends java.lang.Object


Field Summary
static java.lang.String RESTSERVICE_EAR
          Deprecated. use RestServiceGatewayConstants.REST_GATEWAY_EAR
 
Constructor Summary
WBIRestServicesHelper()
           
 
Method Summary
static boolean addWBIRestEndpoint(com.ibm.websphere.management.Session session, java.lang.String contextId, java.lang.String appName, java.lang.String webModuleName, java.lang.String endpointName, java.lang.String endpointDesc, java.lang.String providerEndpointId, java.lang.String endpointType, java.lang.String endpointJndi, java.lang.String endpointVersion, java.lang.String endpointUrlSuffix, java.lang.String typeDisplayName, boolean isPublic, java.lang.Boolean enable)
          Adds a WBIRestServiceEndpoint to the configuration
static boolean addWBIRestWebModule(com.ibm.websphere.management.Session session, java.lang.String contextId, java.lang.String appName, java.lang.String webModuleName, java.lang.String contextRoot, java.lang.String transportType, java.lang.String hostname, java.lang.String port)
          Add a WBIRestWebModule to the REST configuration
static boolean configDefaultRestEndpoints(com.ibm.websphere.management.Session session, java.lang.String contextId)
          configDefaultRestEndpoints Create the default configuration for the RestServices configured to the provider
static boolean configRestGatewayDefaultServices(com.ibm.websphere.management.Session session, java.lang.String contextId, java.lang.String type, java.lang.String version, boolean enable)
           
static org.eclipse.emf.common.util.EList getDefaultWBIRestWebModules(com.ibm.websphere.management.Session session, java.lang.String contextId)
          Deprecated. Use getRestGatewayWBIRestWebModules, with type=null, version=null and enable = true
protected static java.lang.String getDeploymentTargetContextID(java.lang.String clusterName, java.lang.String nodeName, java.lang.String serverName)
           
static java.lang.String getRestGatewayApplicationName(com.ibm.websphere.management.Session session, java.lang.String clusterName, java.lang.String nodeName, java.lang.String serverName)
           
static WBIRestWebModule getRestGatewayProvider(java.lang.String clusterName, java.lang.String nodeName, java.lang.String serverName)
           
static org.eclipse.emf.common.util.EList getRestGatewayWBIRestWebModules(com.ibm.websphere.management.Session session, java.lang.String contextId, java.lang.String type, java.lang.String version)
          getRestGatewayWBIRestWebModules returns the WBIRestWebModule for the contextId updating the values already stored in the configuration if not found creates one with default values Uses RestServiceGateway as the provider Note: only the gateway provider uses this
static java.lang.String getRestServiceAbsoluteURL(java.lang.String transportType, java.lang.String hostName, java.lang.String port, java.lang.String contextRoot, java.lang.String relativeURL)
           
static java.lang.String getRestServiceAbsoluteURL(WBIRestEndpoint restService)
           
static java.util.ArrayList<RestServicesAdminChangeListener> getRESTServicesAdminUpdateListeners()
           
static java.lang.String getScopedAppName(java.lang.String clusterName, java.lang.String nodeName, java.lang.String serverName, java.lang.String appName)
           
static org.eclipse.emf.common.util.EList getWBIRestWebModules(com.ibm.websphere.management.Session session, java.lang.String contextId, com.ibm.ws.rest.services.RestServicesProvider provider, java.lang.String type, java.lang.String version)
          getWBIRestWebModule returns the WBIRestWebModule for the contextId and the provider, updating the values already stored in the configuration if not found creates one with default values Note: only the gateway provider uses this
static boolean installRestServiceGateway(com.ibm.websphere.management.Session session, java.lang.String clusterName, java.lang.String nodeName, java.lang.String serverName)
           
static boolean installRestServiceGateway(com.ibm.websphere.management.Session session, java.lang.String clusterName, java.lang.String nodeName, java.lang.String serverName, java.lang.String appName)
           
static boolean installRestServiceGatewayWithScopeName(com.ibm.websphere.management.Session session, java.lang.String clusterName, java.lang.String nodeName, java.lang.String serverName, java.lang.String appName)
           
static boolean isRESTServiceEnabled(java.lang.String clusterName, java.lang.String nodeName, java.lang.String serverName, java.lang.String appName, java.lang.String webModuleName, java.lang.String type, java.lang.String version)
           
protected static void mapRestGatewayDMGRWebModToVH(com.ibm.websphere.management.application.client.AppDeploymentController controller)
           
static java.lang.String normalizeParameter(java.lang.String value)
           
protected static java.lang.String normalizeURLFragment(java.lang.String value)
           
static void SaveRestServicesConfiguration(com.ibm.websphere.management.Session session, WBIRestDeploymentTarget deploymentTarget)
          Deprecated. use saveWBIRestWebModule instead
static boolean saveWBIRestWebModules(com.ibm.websphere.management.Session session, java.lang.String contextId, org.eclipse.emf.common.util.EList webModules)
           
static boolean updateWBIRestEndpoint(com.ibm.websphere.management.Session session, java.lang.String contextId, java.lang.String appName, java.lang.String webModuleName, java.lang.String endpointName, java.lang.String endpointDesc, java.lang.String providerEndpointId, java.lang.String endpointType, java.lang.String endpointJndi, java.lang.String endpointVersion, java.lang.String endpointUrlSuffix, java.lang.String typeDisplayName, boolean isPublic, java.lang.Boolean enable)
          Updates the WBIRestServiceEndpoint
static boolean updateWBIRestWebModule(com.ibm.websphere.management.Session session, java.lang.String restDeploymentTargetContextID, java.lang.String appName, java.lang.String webModuleName, java.lang.String contextRoot, java.lang.String transportType, java.lang.String hostName, java.lang.String port)
           
protected static void validateDeploymentTarget(java.lang.String clusterName, java.lang.String nodeName, java.lang.String serverName, boolean optionalTarget)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESTSERVICE_EAR

public static final java.lang.String RESTSERVICE_EAR
Deprecated. use RestServiceGatewayConstants.REST_GATEWAY_EAR
See Also:
Constant Field Values
Constructor Detail

WBIRestServicesHelper

public WBIRestServicesHelper()
Method Detail

getWBIRestWebModules

public static org.eclipse.emf.common.util.EList getWBIRestWebModules(com.ibm.websphere.management.Session session,
                                                                     java.lang.String contextId,
                                                                     com.ibm.ws.rest.services.RestServicesProvider provider,
                                                                     java.lang.String type,
                                                                     java.lang.String version)
getWBIRestWebModule returns the WBIRestWebModule for the contextId and the provider, updating the values already stored in the configuration if not found creates one with default values Note: only the gateway provider uses this

Parameters:
session -
contextId -
provider -
Returns:
EList of the WBIRestWebModules

getRestGatewayWBIRestWebModules

public static org.eclipse.emf.common.util.EList getRestGatewayWBIRestWebModules(com.ibm.websphere.management.Session session,
                                                                                java.lang.String contextId,
                                                                                java.lang.String type,
                                                                                java.lang.String version)
getRestGatewayWBIRestWebModules returns the WBIRestWebModule for the contextId updating the values already stored in the configuration if not found creates one with default values Uses RestServiceGateway as the provider Note: only the gateway provider uses this

Parameters:
session -
contextId -
Returns:

getDefaultWBIRestWebModules

public static org.eclipse.emf.common.util.EList getDefaultWBIRestWebModules(com.ibm.websphere.management.Session session,
                                                                            java.lang.String contextId)
Deprecated. Use getRestGatewayWBIRestWebModules, with type=null, version=null and enable = true

getDefaultWBIRestWebModule returns the WBIRestWebModule for the contextId updating the values already stored in the configuration if not found creates one with default values Uses RestServiceGateway as the provider Note: only the gateway provider uses this

Parameters:
session -
contextId -
Returns:

saveWBIRestWebModules

public static boolean saveWBIRestWebModules(com.ibm.websphere.management.Session session,
                                            java.lang.String contextId,
                                            org.eclipse.emf.common.util.EList webModules)

addWBIRestWebModule

public static boolean addWBIRestWebModule(com.ibm.websphere.management.Session session,
                                          java.lang.String contextId,
                                          java.lang.String appName,
                                          java.lang.String webModuleName,
                                          java.lang.String contextRoot,
                                          java.lang.String transportType,
                                          java.lang.String hostname,
                                          java.lang.String port)
Add a WBIRestWebModule to the REST configuration

Parameters:
session -
contextId -
appName -
webModuleName -
contextRoot -
transportType -
hostname -
port -
Returns:
Throws:
RestConfigurationHelperException

addWBIRestEndpoint

public static boolean addWBIRestEndpoint(com.ibm.websphere.management.Session session,
                                         java.lang.String contextId,
                                         java.lang.String appName,
                                         java.lang.String webModuleName,
                                         java.lang.String endpointName,
                                         java.lang.String endpointDesc,
                                         java.lang.String providerEndpointId,
                                         java.lang.String endpointType,
                                         java.lang.String endpointJndi,
                                         java.lang.String endpointVersion,
                                         java.lang.String endpointUrlSuffix,
                                         java.lang.String typeDisplayName,
                                         boolean isPublic,
                                         java.lang.Boolean enable)
Adds a WBIRestServiceEndpoint to the configuration

Parameters:
session -
contextId -
appName -
webModuleName -
endpointName -
endpointDesc -
providerEndpointId -
endpointType -
endpointJndi -
endpointVersion -
endpointUrlSuffix -
Returns:
Throws:
RestConfigurationHelperException

updateWBIRestWebModule

public static boolean updateWBIRestWebModule(com.ibm.websphere.management.Session session,
                                             java.lang.String restDeploymentTargetContextID,
                                             java.lang.String appName,
                                             java.lang.String webModuleName,
                                             java.lang.String contextRoot,
                                             java.lang.String transportType,
                                             java.lang.String hostName,
                                             java.lang.String port)

updateWBIRestEndpoint

public static boolean updateWBIRestEndpoint(com.ibm.websphere.management.Session session,
                                            java.lang.String contextId,
                                            java.lang.String appName,
                                            java.lang.String webModuleName,
                                            java.lang.String endpointName,
                                            java.lang.String endpointDesc,
                                            java.lang.String providerEndpointId,
                                            java.lang.String endpointType,
                                            java.lang.String endpointJndi,
                                            java.lang.String endpointVersion,
                                            java.lang.String endpointUrlSuffix,
                                            java.lang.String typeDisplayName,
                                            boolean isPublic,
                                            java.lang.Boolean enable)
Updates the WBIRestServiceEndpoint

Parameters:
session -
contextId -
appName -
webModuleName -
endpointName -
endpointDesc -
providerEndpointId -
endpointType -
endpointJndi -
endpointVersion -
endpointUrlSuffix -
Returns:
Throws:
RestConfigurationHelperException

configDefaultRestEndpoints

public static boolean configDefaultRestEndpoints(com.ibm.websphere.management.Session session,
                                                 java.lang.String contextId)
configDefaultRestEndpoints Create the default configuration for the RestServices configured to the provider

Parameters:
session - - ManagementSession
contextId -
Returns:

configRestGatewayDefaultServices

public static boolean configRestGatewayDefaultServices(com.ibm.websphere.management.Session session,
                                                       java.lang.String contextId,
                                                       java.lang.String type,
                                                       java.lang.String version,
                                                       boolean enable)

SaveRestServicesConfiguration

public static void SaveRestServicesConfiguration(com.ibm.websphere.management.Session session,
                                                 WBIRestDeploymentTarget deploymentTarget)
Deprecated. use saveWBIRestWebModule instead


installRestServiceGateway

public static boolean installRestServiceGateway(com.ibm.websphere.management.Session session,
                                                java.lang.String clusterName,
                                                java.lang.String nodeName,
                                                java.lang.String serverName,
                                                java.lang.String appName)

getScopedAppName

public static java.lang.String getScopedAppName(java.lang.String clusterName,
                                                java.lang.String nodeName,
                                                java.lang.String serverName,
                                                java.lang.String appName)

installRestServiceGatewayWithScopeName

public static boolean installRestServiceGatewayWithScopeName(com.ibm.websphere.management.Session session,
                                                             java.lang.String clusterName,
                                                             java.lang.String nodeName,
                                                             java.lang.String serverName,
                                                             java.lang.String appName)

getRestGatewayApplicationName

public static java.lang.String getRestGatewayApplicationName(com.ibm.websphere.management.Session session,
                                                             java.lang.String clusterName,
                                                             java.lang.String nodeName,
                                                             java.lang.String serverName)

installRestServiceGateway

public static boolean installRestServiceGateway(com.ibm.websphere.management.Session session,
                                                java.lang.String clusterName,
                                                java.lang.String nodeName,
                                                java.lang.String serverName)

mapRestGatewayDMGRWebModToVH

protected static void mapRestGatewayDMGRWebModToVH(com.ibm.websphere.management.application.client.AppDeploymentController controller)
                                            throws com.ibm.wbi.utils.configservice.WBIConfigException
Throws:
com.ibm.wbi.utils.configservice.WBIConfigException

getRestGatewayProvider

public static WBIRestWebModule getRestGatewayProvider(java.lang.String clusterName,
                                                      java.lang.String nodeName,
                                                      java.lang.String serverName)
                                               throws com.ibm.wbi.utils.configservice.WBIConfigException
Throws:
com.ibm.wbi.utils.configservice.WBIConfigException

isRESTServiceEnabled

public static boolean isRESTServiceEnabled(java.lang.String clusterName,
                                           java.lang.String nodeName,
                                           java.lang.String serverName,
                                           java.lang.String appName,
                                           java.lang.String webModuleName,
                                           java.lang.String type,
                                           java.lang.String version)
                                    throws com.ibm.wbi.utils.configservice.WBIConfigException
Throws:
com.ibm.wbi.utils.configservice.WBIConfigException

validateDeploymentTarget

protected static void validateDeploymentTarget(java.lang.String clusterName,
                                               java.lang.String nodeName,
                                               java.lang.String serverName,
                                               boolean optionalTarget)
                                        throws com.ibm.wbi.utils.configservice.WBIConfigException
Throws:
com.ibm.wbi.utils.configservice.WBIConfigException

getDeploymentTargetContextID

protected static java.lang.String getDeploymentTargetContextID(java.lang.String clusterName,
                                                               java.lang.String nodeName,
                                                               java.lang.String serverName)
                                                        throws com.ibm.wbi.utils.configservice.WBIConfigException
Throws:
com.ibm.wbi.utils.configservice.WBIConfigException

normalizeParameter

public static java.lang.String normalizeParameter(java.lang.String value)

getRestServiceAbsoluteURL

public static java.lang.String getRestServiceAbsoluteURL(WBIRestEndpoint restService)

getRestServiceAbsoluteURL

public static java.lang.String getRestServiceAbsoluteURL(java.lang.String transportType,
                                                         java.lang.String hostName,
                                                         java.lang.String port,
                                                         java.lang.String contextRoot,
                                                         java.lang.String relativeURL)

getRESTServicesAdminUpdateListeners

public static java.util.ArrayList<RestServicesAdminChangeListener> getRESTServicesAdminUpdateListeners()

normalizeURLFragment

protected static java.lang.String normalizeURLFragment(java.lang.String value)