Server management commands  refresh

Chapter 8: Using wstool, wstkeytool, wstant, and wstkeytoolant

list

Description

Returns a list of entities from the server’s repository, depending on the type of entity entered.

NoteEntity type is not an option, do not use a “-” when specifying an entity type.

Syntax

Command line:

list 
[Collections] 
[CompType] 
[Components] 
[Listeners] 
[Methods] 
[Packages] 
[Params] 
[Props] 
[PropsValue] 
[ReturnType] 
[Roles] 
[ServerProps] 
[ServerVersion] 
[ServiceName] 
[Services] 
[Stats] 
[URL] 
[WSDD] 
[WSDL] 
[typemappings] 
[undefTypes] 
Entity

Ant build file:

<taskdef name="wst_antTask" classname="com.sybase.wst.wstool.ant.AntTask"/>
<target name="list" > <wst_antTask command="list"
[option=“option_depending_on_entity”] >

Where:

Type

Description

Collections

Returns a list of Web service collections.

CompType

Returns the component type. Entity is in the form of component:PackageName/ComponentName.

Components

Returns a list of SOAPable components available on the server.

Listeners

Returns a list of listeners in the format of “<protocol>:<host>:<port>”. For example, “http:localhost:8080”

Methods

Returns a list of methods for the entity. Entity can be in the form of either:

  • service:CollectionName/ServiceName or

  • component:PackageName/ComponentName

Include the -methodType option and specify the type of methods returned:

allowed – list only the allowed methods.

disallowed – list only the disallowed methods.

all – list all methods (default).

Packages

Returns a list of SOAPable packages available on the server.

Params

Returns a list of parameters for a given method. Entity is in the format of:

method:CollectionName/ServiceName/MethodName

Props

Returns a list of properties of a given entity, for example:

collection:CollectionName

PropsValue

Returns the property value for the given property. Use the -name argument and provide the name of the property for which the value is returned. Entity can be one of:

  • collection:CollectionName

  • server:ServerName

ReturnType

Returns the return type of a given method. Entity is in the form of:

method:CollectionName/ServiceName/MethodName

Roles

Returns a list of roles for a given Web service or Web service method. Entity is one of:

  • method:CollectionName/ServiceName/MethodName

  • service:CollectionName/ServiceName

ServerProps

Returns a list of server properties.

ServerVersion

Returns the server version.

ServiceName

Returns the Web service name of a given component. Entity is in the form of:

component:PackageName/ComponentName

Services

Returns the list of Web services for a given collection. Use the -serviceType argument with one of the following options:

all – list all Web services

active – list only active Web services

Entity is in the form of:

collection:CollectionName

Stats

Displays the statistics for a given Web service or Web service method. Entity is one of:

  • method:CollectionName/ServiceName/MethodName

  • service:CollectionName/ServiceName

NoteYou must first enable statistics monitoring before you can display statistics. See startStats.

URL

Returns the service URL of a given Web service is . Entity is in the form of:

service:CollectionName/ServiceName

WSDD

Lists the .wsdd of a given Web service. Use the -out argument and supply a file name to direct the .wsdd to a file. The default file is collectionName_serviceName.wsdd. Entity is in the form of:

service:CollectionName/ServiceName

WSDL

Lists the .wsdl of a given Web service. Use the -out argument and supply a file name to direct the .wsdl to a file. The default file is collectionName_serviceName.wsdl. Entity is in the form of:

service:CollectionName/ServiceName

typemappings

Returns a list of the type mappings for a given Web service. Entity is in the format of:

service:CollectionName/ServiceName

undefTypes

Returns a list of the undefined types for a given soapable component. Entity is on of:

  • method:PackageName/ComponentName/MethodName

  • class name

Entity

Varies depending on the selected option.

Examples

Example 1

This command lists all the listeners running on the server:

wstool list Listeners

Example 2

This command directs the WSDL for MyWebService to the test.wsdl file:

wstool list wsdl -out test.wsdl service:MyCollection/MyWebService

Ant build example:

<wst_antTask command="list" type="wsdl" entity: “service:MyCollection/MyWebService”/>




Copyright © 2005. Sybase Inc. All rights reserved. refresh