WebSphere Application Server Version 6.1 Feature Pack for Web Services
             Operating Systems: AIX, HP-UX, i5/OS, Linux, Solaris, Windows, z/OS

             Personalize the table of contents and search results
             New or updated topic for this feature pack

WebServicesAdmin command group for the AdminTask object

Use this topic as a reference for the commands for the WebServicesAdmin group of the AdminTask object. Use these commands with your administrative scripts to list available Web services, list web services attributes, determine the endpoint configuration for a Web service, and determine a specific operation name.

Use the commands in the WebServicesAdmin group to query information for installed web services. For more information about the AdminTask object, see the Commands for the AdminTask object article.

The following commands are available for the WebServicesAdmin group of the AdminTask object.

listWebServices

The listWebServices command retrieves a list of available Web services for one or all applications. If an application name is not supplied, the command lists all of the Web services.

Target object

None.

Required parameters

None.

Optional parameters

-application
The name of the deployed application. If you do not specify this parameter, the command returns all Web services in the cell. (String, optional)
-client
Whether the Web service is a provider or a client. The default value is false (service provider). When set to true, the command only returns Web service clients. (Boolean, optional)

Return value

All Web services for the application specified. For each Web service, the command returns the following attributes and corresponding values: application name, module name, service name, whether the Web service is a service provider or client, and service type. The service type is only specified if the Web service is a service provider.

Batch mode example usage

Using Jython string:
AdminTask.listWebServices('[–application application1 -client false]')
Sample output:
'[[service {http://www.ibm.com}service1][application application1][module 
webapp1.war][type JAX-WS][client false]]'

Interactive mode example usage

Using Jython string:
AdminTask.listWebServices ('[-interactive]')
Using Jython list:
AdminTask.listWebServices (['-interactive'])

getWebService

The getWebService command retrieves the attributes for a Web service.

Target object

None.

Required parameters

-application
The name of the deployed application. (String, required)
-module
The name of the module. (String, required)
-service
The name of the Web service. (String, required)

Optional parameters

-client
Whether the Web service is a provider or a client. The default value is false (service provider). When set to true, the command only returns Web service clients. (Boolean, optional)

Return value

Returns a list of attributes, including service name, whether the service is a provider or client, and service type. The service type attribute is only applicable for service providers.

Batch mode example usage

Using Jython string:
AdminTask.getWebService('[–application application_name -module 
module_name -service webservice_name -client false]')
Sample output:
'[[service {http://www.ibm.com}service1][type JAX-WS][client false]]'

Interactive mode example usage

Using Jython string:
AdminTask.getWebService ('[-interactive]')
Using Jython list:
AdminTask.getWebService (['-interactive'])

listWebServicesEndpoints

The listWebServicesEndpoints command returns a list of logical endpoints for a Web service. The logical endpoint name is the port name in the Web Services Description Language (WSDL) document.

Target object

None.

Required parameters

-application
The name of the deployed application. (String, required)
-module
The name of the module. (String, required)
-service
The name of the Web service. (String, required)

Optional parameters

-client
Whether the Web service is a provider or a client. The default value is false (service provider). When set to true, the command only returns Web service clients. (Boolean, optional)

Return value

Returns the logical endpoint name for the Web service specified.

Batch mode example usage

Using Jython string:
AdminTask.listWebServiceEndpoints('[–application application_name
 -module module_name -service webservice_name -client false]')
Sample output:
'[[logicalEndpoint QuotePort01]]'

Interactive mode example usage

Using Jython string:
AdminTask.listWebServicesEndpoints 
('[-interactive]')
Using Jython list:
AdminTask.listWebServicesEndpoints 
(['-interactive'])

listWebServicesOperations

The listWebServicesOperations command returns a list of Web service operations.

Target object

None.

Required parameters

-application
The name of the deployed application. (String, required)
-module
The name of the module. (String, required)
-service
The name of the Web service. (String, required)
-logicalEndpoint
The port name in the Web Services Description Language (WSDL) document. (String, required)

Optional parameters

-client
Whether the Web service is a provider or a client. The default value is false (service provider). When set to true, the command only returns Web service clients. (Boolean, optional)

Return value

Returns the operation name for the Web service specified.

Batch mode example usage

Using Jython string:
AdminTask.listWebServiceOperations('[–application application_name -module 
module_name -service webservice_name -client false -logicalEndpoint endpoint_name]')
Sample output:
'[[operation ivt_app_op1][operation ivt_app_op2]]'

Interactive mode example usage

Using Jython string:
AdminTask.listWebServicesOperations ('[-interactive]')
Using Jython list:
AdminTask.listWebServicesOperations (['-interactive'])



Related tasks
Using the AdminTask object for scripted administration
Querying Web services with the wsadmin tool
Reference topic    

Terms of Use | Feedback

Last updated: Nov 25, 2008 2:35:59 AM CST
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp?topic=/com.ibm.websphere.wsfep.multiplatform.doc/info/ae/ae/rxml_wsfpwebservicesadmin.html