+

Search Tips   |   Advanced Search

Set the scope of a Web service port with wsadmin


When a Web service application is deployed into WAS, an instance is created for each application or module. The instance contains deployment information for the Web module or Enterprise Java Beans (EJB) module, including implementation scope, client bindings and deployment descriptor information. There are three levels of scope that can be set: application, session and request.

If we have not deployed the EAR file yet, you need to have it ready or already deployed to the appserver.

The primary purpose of this task is to enable the configuration of the Web service port scope. The scope originally specified when the Java Bean object is enabled as a Web service during the development process can be changed with the WebServicesServerBindPort command. The scope attribute does not apply to Web services that use JMS transport or to enterprise beans.

Web Services for Java 2 platform Enterprise Edition (J2EE) specifies that Web services implementations must be stateless. Therefore, to maintain spec compliance, the scope can remain at the application level because the state relevant to the individual sessions level or the requests level is not supposed to be maintained in the implementation. To deviate from the spec and want to access a different Java Bean instance, because we are looking for information that is located in another Java Bean, the scope settings need to change.

The setting that you configure for the scope determines how frequently a new instance of a service implementation class is created for the Web service ports in a module. The application scope causes the same instance of the implementation to be used for all requests on the application. The session scope causes the same instance to be used for all requests in each session. The request scope causes a new instance to be used for every request. For example, with the scope set to application, every message that comes to the server accesses the same Java bean instance.

To change the scope setting through wsadmin:

 

  1. Launch a scripting command.

  2. Set the scope of the Web service port.

    To use the existing listener port instead of using or creating a new activation specification, determine whether the EJB JAR version is lower than 2.1. The system automatically creates and uses an activation spec when specify the -usedefaultbindings option to deploy an application. If an activation spec exists, the system ignores the listener port, and instead uses the activation specification. To deploy an application with an EJB JAR version greater than or equal to 2.1 using the defined listener ports instead of a new activation specification, set the com.ibm.websphere.management.application.dfltbndng.mdb.preferexisting system property to true in the wsadmin.properties file in the properties directory of the profile of interest.

    Use the install, installInteractive, edit, or editInteractive options to configure the scope of the Web service port, as the following syntax demonstrates: 

    $AdminApp install app_name {-usedefaultbindings -deployejb 
-WebServicesServerBindPort {{<module_name> <Web_service> <port><scope_setting>}...}
    The previous example indicates that the scope of multiple ports can be changed using one WebServicesServerBindPort command, where:

    • app_name is the application name, for example WebServicesSample.ear

    • module_name is the module name, for example AddressBookW2JE.jar

    • Web_service is the name of the Web service, for example AddressBookW2JE service/WSLoggerService2

    • port is the name of the port, for example AddressBook

    • scope_setting is the level of setting for scope, for example Session

 

Results

The scope for a Web service port is configured.

 

Example

The following example of the presents the application, module, Web service, port and scope as it is written in the command line: 

$AdminApp install WebServicesSamples.ear {-usedefaultbindings -deployejb -deployws 
-WebServicesServerBindPort {{AddressBookJ2WB.war AddressBookService AddressBook request} 
{AddressBookW2JB.war AddressBookService AddressBook application}}}

 

What to do next

Now we can finish any other configurations, start or restart the application, and verify expected behavior of the Web service.

 

Related tasks


Web services client port information
Web services client bindings
Set Web service client-preferred port mappings with wsadmin
Set Web service client port information with wsadmin

 

Related


Options for the AdminApp object install, installInteractive, edit, editInteractive, update, and updateInteractive commands