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

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

public class RestConfigurationHelper
extends java.lang.Object


Constructor Summary
RestConfigurationHelper(com.ibm.websphere.management.Session session, com.ibm.ws.rest.services.RestServicesProvider provider)
           
 
Method Summary
 void addRestDeploymentTarget(WBIRestDeploymentTarget deploymentTarget)
           
 void addRestEndpoint(WBIRestDeploymentTarget deploymentTarget, WBIRestWebModule webModule, WBIRestEndpoint endpoint)
           
 void addRestWebModule(WBIRestDeploymentTarget deploymentTarget, WBIRestWebModule webModule)
           
 WBIRestDeploymentTarget createRestDeploymentTarget(java.lang.String contextId)
           
 WBIRestEndpoint createRestEndpoint(java.lang.String name, java.lang.String desc, java.lang.String providerEndpointId, java.lang.String type, java.lang.String jndi, java.lang.String version, java.lang.String urlSuffix, java.lang.String typeDisplayName, boolean isPublic, java.lang.Boolean enable)
           
 WBIRestWebModule createRestWebModule(java.lang.String appName, java.lang.String webModuleName, java.lang.String contextRoot, java.lang.String host, java.lang.String port, java.lang.String transportType)
           
 WBIRestDeploymentTarget getRestDeploymentTarget(java.lang.String contextId)
           
 org.eclipse.emf.common.util.EList getRestDeploymentTargets()
           
 WBIRestEndpoint getRestEndpoint(WBIRestWebModule wm, java.lang.String providerEndpointId, java.lang.String type, java.lang.String version)
           
static WBIRestEndpoint getRESTService(java.lang.String restDeploymentTargetContextID, java.lang.String appName, java.lang.String webModuleName, java.lang.String type, java.lang.String version)
           
static WBIRestEndpoint getRESTService(java.lang.String restDeploymentTargetContextID, java.lang.String appName, java.lang.String webModuleName, java.lang.String name, java.lang.String type, java.lang.String version)
           
static WBIRestWebModule getRESTServiceProvider(java.lang.String restDeploymentTargetContextID, java.lang.String appName, java.lang.String webModuleName)
           
 WBIRestWebModule getRestWebModule(WBIRestDeploymentTarget dt, java.lang.String appName, java.lang.String webModuleName)
           
static WBIRestDeploymentTarget getWBIRestDeploymentTarget(java.lang.String restDeploymentTargetContextID)
           
 void removeRestEndpoint(WBIRestDeploymentTarget deploymentTarget, WBIRestWebModule webModule, WBIRestEndpoint endpoint)
          Remove the RestEndpoint from the configuration
 void removeRestWebModule(WBIRestDeploymentTarget deploymentTarget, WBIRestWebModule webModule)
          Removes the webModule from the configuration
 void saveConfiguration()
           
 void updateDefaultHostPort(WBIRestDeploymentTarget deploymentTarget, WBIRestWebModule webModule)
          Update the webModule default host/port based on the contextId, hostname values provided
 WBIRestEndpoint updateRestEndpoint(WBIRestDeploymentTarget deploymentTarget, WBIRestWebModule webModule, WBIRestEndpoint endpoint, java.lang.String name, java.lang.String desc, java.lang.String providerEndpointId, java.lang.String type, java.lang.String jndi, java.lang.String version, java.lang.String urlSuffix, java.lang.String typeDisplayName, boolean isPublic, java.lang.Boolean enable)
           
 void updateRestWebModule(WBIRestDeploymentTarget deploymentTarget, WBIRestWebModule webModule, java.lang.String appName, java.lang.String webModuleName, java.lang.String contextRoot, java.lang.String hostname, java.lang.String port, java.lang.String transportType)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RestConfigurationHelper

public RestConfigurationHelper(com.ibm.websphere.management.Session session,
                               com.ibm.ws.rest.services.RestServicesProvider provider)
                        throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException
Method Detail

createRestEndpoint

public WBIRestEndpoint createRestEndpoint(java.lang.String name,
                                          java.lang.String desc,
                                          java.lang.String providerEndpointId,
                                          java.lang.String type,
                                          java.lang.String jndi,
                                          java.lang.String version,
                                          java.lang.String urlSuffix,
                                          java.lang.String typeDisplayName,
                                          boolean isPublic,
                                          java.lang.Boolean enable)
                                   throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

createRestWebModule

public WBIRestWebModule createRestWebModule(java.lang.String appName,
                                            java.lang.String webModuleName,
                                            java.lang.String contextRoot,
                                            java.lang.String host,
                                            java.lang.String port,
                                            java.lang.String transportType)
                                     throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

createRestDeploymentTarget

public WBIRestDeploymentTarget createRestDeploymentTarget(java.lang.String contextId)
                                                   throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

getRestDeploymentTarget

public WBIRestDeploymentTarget getRestDeploymentTarget(java.lang.String contextId)
                                                throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

getRestDeploymentTargets

public org.eclipse.emf.common.util.EList getRestDeploymentTargets()
                                                           throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

getRestWebModule

public WBIRestWebModule getRestWebModule(WBIRestDeploymentTarget dt,
                                         java.lang.String appName,
                                         java.lang.String webModuleName)
                                  throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

getRestEndpoint

public WBIRestEndpoint getRestEndpoint(WBIRestWebModule wm,
                                       java.lang.String providerEndpointId,
                                       java.lang.String type,
                                       java.lang.String version)
                                throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

addRestDeploymentTarget

public void addRestDeploymentTarget(WBIRestDeploymentTarget deploymentTarget)
                             throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

addRestWebModule

public void addRestWebModule(WBIRestDeploymentTarget deploymentTarget,
                             WBIRestWebModule webModule)
                      throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

addRestEndpoint

public void addRestEndpoint(WBIRestDeploymentTarget deploymentTarget,
                            WBIRestWebModule webModule,
                            WBIRestEndpoint endpoint)
                     throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

updateRestEndpoint

public WBIRestEndpoint updateRestEndpoint(WBIRestDeploymentTarget deploymentTarget,
                                          WBIRestWebModule webModule,
                                          WBIRestEndpoint endpoint,
                                          java.lang.String name,
                                          java.lang.String desc,
                                          java.lang.String providerEndpointId,
                                          java.lang.String type,
                                          java.lang.String jndi,
                                          java.lang.String version,
                                          java.lang.String urlSuffix,
                                          java.lang.String typeDisplayName,
                                          boolean isPublic,
                                          java.lang.Boolean enable)
                                   throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

updateRestWebModule

public void updateRestWebModule(WBIRestDeploymentTarget deploymentTarget,
                                WBIRestWebModule webModule,
                                java.lang.String appName,
                                java.lang.String webModuleName,
                                java.lang.String contextRoot,
                                java.lang.String hostname,
                                java.lang.String port,
                                java.lang.String transportType)
                         throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

removeRestWebModule

public void removeRestWebModule(WBIRestDeploymentTarget deploymentTarget,
                                WBIRestWebModule webModule)
                         throws RestConfigurationHelperException
Removes the webModule from the configuration

Parameters:
deploymentTarget -
webModule -
Throws:
RestConfigurationHelperException

removeRestEndpoint

public void removeRestEndpoint(WBIRestDeploymentTarget deploymentTarget,
                               WBIRestWebModule webModule,
                               WBIRestEndpoint endpoint)
                        throws RestConfigurationHelperException
Remove the RestEndpoint from the configuration

Parameters:
deploymentTarget -
webModule -
endpoint -
Throws:
RestConfigurationHelperException

updateDefaultHostPort

public void updateDefaultHostPort(WBIRestDeploymentTarget deploymentTarget,
                                  WBIRestWebModule webModule)
                           throws RestConfigurationHelperException
Update the webModule default host/port based on the contextId, hostname values provided

Parameters:
deploymentTarget -
webModule -
Throws:
RestConfigurationHelperException

saveConfiguration

public void saveConfiguration()
                       throws RestConfigurationHelperException
Throws:
RestConfigurationHelperException

getWBIRestDeploymentTarget

public static WBIRestDeploymentTarget getWBIRestDeploymentTarget(java.lang.String restDeploymentTargetContextID)
                                                          throws com.ibm.wbi.utils.configservice.WBIConfigException
Throws:
com.ibm.wbi.utils.configservice.WBIConfigException

getRESTService

public static WBIRestEndpoint getRESTService(java.lang.String restDeploymentTargetContextID,
                                             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

getRESTService

public static WBIRestEndpoint getRESTService(java.lang.String restDeploymentTargetContextID,
                                             java.lang.String appName,
                                             java.lang.String webModuleName,
                                             java.lang.String name,
                                             java.lang.String type,
                                             java.lang.String version)
                                      throws com.ibm.wbi.utils.configservice.WBIConfigException
Throws:
com.ibm.wbi.utils.configservice.WBIConfigException

getRESTServiceProvider

public static WBIRestWebModule getRESTServiceProvider(java.lang.String restDeploymentTargetContextID,
                                                      java.lang.String appName,
                                                      java.lang.String webModuleName)
                                               throws com.ibm.wbi.utils.configservice.WBIConfigException
Throws:
com.ibm.wbi.utils.configservice.WBIConfigException