Use the WLST commands listed in Table 3-5 to view and manage web services for deployed, active, and running web service applications.
Note:
The commands listed in Table 3-5 have an application argument.
In an multi-tenant environment, if you intend to target a specific application instance within a tenant's partition, then you must include the partition name as part of the application as follows:
/domain/server/application#version$partition
However, if you are targeting a domain-scoped application, then you do not have to include the partition name. You can use the application argument as follows:
/domain/server/application#version
Table 3-5 Web Service and Client Management WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
List web service client ports information for an application or SOA composite. |
Online |
|
|
List web service client information for an application, SOA composite, or domain. |
Online |
|
|
List web service client port stub properties for an application or SOA composite. |
Online |
|
|
List the web service ports for a web service application or SOA composite. |
Online |
|
|
List the web service information for an application, composite, or domain. |
Online |
|
|
Configure the set of stub properties of a web service client port for an application or SOA composite. |
Online |
|
|
Set, change, or delete a single stub property of a web service client port for an application or SOA composite. |
Online |
Command Category: Web Service and Client Management
Use with WLST: Online
Description
Lists the web service port names and the endpoint URLs for web service clients in an application or SOA composite.
The output will display the name of the web service client/reference port. For example:
AppModuleServiceSoapHttpPort
Syntax
listWebServiceClientPorts(application,moduleOrCompName,moduleType,serviceRefName)
| Argument | Definition |
|---|---|
|
|
Name and path of the application for which you want to list the web services port information. For example, To list the client port information for an application, this argument is required. |
|
|
Name of the Web module or SOA composite (for example, HelloWorld[1.0]) for which you want to list the web service client port information. To list the client port information for a SOA composite, the composite name is required (for example, |
|
|
Module type. Valid options are:
|
|
|
Service reference name of the application or SOA composite for which you want to list the web service client port information. When the client is an asynchronous web service callback client, the |
Examples
The following example lists the client ports for the WssUsernameClient Web module in the /base_domain/server1/jwsclient_1#1.1.0 application. Note that the moduleType is set to wsconn, and the serviceRefName is set to WssUsernameClient.
wls:/base_domain/serverConfig> listWebServiceClientPorts ('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn', 'WssUsernameClient')
The following example lists the client ports in the default/HelloWorld[1.0] SOA composite. Note that the moduleType is set to soa, and the serviceRefName is set to client.
wls:/base_domain/serverConfig> listWebServiceClientPorts(None, 'default/HelloWorld[1.0]','soa','client')
Command Category: Web Service and Client Management
Use with WLST: Online
Description
Lists web service clients information for an application, SOA composite, or domain. If neither an application nor a composite is specified, the command lists information about all Web service clients in all applications and composites for every server instance in the domain. If an application is not specified, the command lists information about all web service clients in all applications for every server instance in the domain.
You can specify the amount of information to be displayed in the output using the detail argument. When specified, the output provides endpoint (port) and policy details for clients in the domain, the secure status of the endpoints, any configuration overrides and constraints, and if the endpoints have a valid configuration. A subject is considered secure if the policies attached to it (either directly or globally) enforce authentication, authorization, or message protection behaviors. Because you can specify the priority of a global or directly attached policy (using the reference.priority configuration override), the effective field indicates if the directly attached policies are in effect for the endpoint.
The local.policy.reference.source configuration property is provided for each directly attached policy identifying the source of the attachment. For more information about the local.policy.reference.source configuration property and a list of valid values, see "Determining the Source of Policy Attachments" in Securing Web Services and Managing Policies with Oracle Web Services Manager.
Note that to simplify endpoint management, all directly attached policies are shown in the output regardless of whether they are in effect. In contrast, only globally attached policies that are in effect for the endpoint are displayed. For more information, see "How the Effective Set of Policies is Calculated" in Securing Web Services and Managing Policies with Oracle Web Services Manager.
The output is listed by each application deployed as shown in the following examples:
This example shows the output of an unsecured endpoint:
wls:/jrfServer_domain/serverConfig> listWebServiceClients(detail=true)
/jrfServer_domain/jrfServer_admin/ADFDCDecoupling_Project1_ADFDCDecoupling :
moduleName=testadfbc, moduleType=wsconn, serviceRefName=AppModuleService
AppModuleServiceSoapHttpPort
The policy subject is not secure in this context.
/soa_domain/soa_server1/soa-infra : compositeName=default/Basic_SOA_Client[1.0], moduleType=soa, serviceRefName=Service1
Basic_soa_service_pt serviceWSDLURI=http://host.example.com:1234/soa-infra/services/default/Basic_SOA_service/Basic_soa_service.wsdl
oracle.webservices.contentTransferEncoding=base64
oracle.webservices.charsetEncoding=UTF-8
oracle.webservices.operationStyleProperty=document
wsat.flowOption=WSDLDriven
oracle.webservices.soapVersion=soap1.1
oracle.webservices.chunkSize=4096
oracle.webservices.session.maintain=false
oracle.webservices.preemptiveBasicAuth=false
oracle.webservices.encodingStyleProperty=http://schemas.xmlsoap.org/soap/encoding/
oracle.webservices.donotChunk=true
No attached policies found; endpoint is not secure.
This example shows the output for a secured endpoint. Note that the local.policy.reference.source configuration property is provided for the directly attached policy identifying its source as LOCAL_ATTACHMENT, indicating that it was attached using either Fusion Middleware Control or WLST. For more information about the local.policy.reference.source configuration property and a list of valid values, see "Determining the Source of Policy Attachments" in Securing Web Services and Managing Policies with Oracle Web Services Manager.
wls:/jrfServer_domain/serverConfig> listWebServiceClients(detail=true)
/jrfServer_domain/jrfServer_admin/ADFDCDecoupling_Project1_ADFDCDecoupling :
moduleName=testadfbc, moduleType=wsconn, serviceRefName=AppModuleService
AppModuleServiceSoapHttpPort serviceWSDLURI=http://host.example.com:1234/ADFBCDecoupling-ADFBCDecoupling-context-root/AppModuleService?wsdl
URI="oracle/wss10_saml_token_with_message_protection_client_policy", category=security, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="LOCAL_ATTACHMENT"
The policy subject is secure in this context.
Syntax
listWebServiceClients(application,composite,[detail])
| Argument | Definition |
|---|---|
|
|
Name and path of the application for which you want to list the web service clients. For example, If specified, all web services clients in the application are listed. |
|
|
Name of the SOA composite for which you want to list the Web service clients. For example, If specified, all Web service clients in the composite are listed. |
|
|
Optional. Specifies whether to list port and policy details for the web service clients. For each directly attached policy, the Valid values are:
|
Examples
The following example lists information for all web service clients in the domain.
wls:/wls-domain/serverConfig>listWebServiceClients()
The following example lists the web service clients for the application jwsclient_1#1.10 for the server server1 in the domain base_domain.
wls:/wls-domain/serverConfig>listWebServiceClients('base_domain/server1/jwsclient_1#1.10')
The following example lists the Web service clients for the SOA composite default/HelloWorld[1.0].
wls:/wls-domain/serverConfig>listWebServiceClients(None,'default/HelloWorld[1.0]')
The following example lists details for all of the web service clients in the domain.
wls:/wls-domain/serverConfig>listWebServiceClients(None,None,true)
Note:
This command applies to Oracle Infrastructure web service clients only.
Command Category: Web Service and Client Management
Use with WLST: Online
Description
Lists web service client port stub properties for an application or SOA composite.
Syntax
listWebServiceClientStubProperties(application, moduleOrCompName, moduleType, serviceRefName, portInfoName)
| Argument | Definition |
|---|---|
|
|
Name and path of the application for which you want to list the web services client port stub properties. For example, To list the client port stub properties information for an application, this argument is required. |
|
|
Name of the Web module or SOA composite (for example, HelloWorld[1.0]) for which you want to list the web services client port stub properties. To list the client port stub properties information for a SOA composite, the composite name is required (for example, |
|
|
Module type. Valid options are:
|
|
|
Service reference name of the application or SOA composite for which you want to list the web service client port stub properties. |
|
|
The name of the client port for which you want to list the stub properties. |
Example
The following example lists the client port stub properties for the JRFWssUsernamePort port of the WssUsernameClient Web module in the /base_domain/server1/jwsclient_1#1.1.0 application. Note that the moduleType is set to wsconn, and the serviceRefName is set to WssUsernameClient.
wls:/base_domain/serverConfig>listWebServiceClientStubProperties ('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn', 'WssUsernameClient','JRFWssUsernamePort')
Command Category: Web Service and Client Management
Use with WLST: Online
Description
Lists the web service port names and the endpoint URLs for a web service application or SOA composite.
The output will display the port name and endpoint URL of the web service port. For example:
JRFWssUsernamePort http://localhost:7001/j2wbasicPolicy/WssUsername
Syntax
listWebServicePorts(application,moduleOrCompName,moduleType,serviceName)
| Argument | Definition |
|---|---|
|
|
Name and path of the application for which you want to list the web services port information. For example, To list the port information for an application, this argument is required. |
|
|
Name of the Web module or SOA composite (for example, HelloWorld[1.0]) for which you want to list the web services port information. To list the port information for a SOA composite, the composite name is required (for example, |
|
|
Module type. Valid options are:
|
|
|
Name of the web service in the application or SOA composite for which you want to list the port information. For example, { |
Example
The following example lists the web service ports and endpoint URLs for the Oracle Infrastructure web service j2wbasicPolicy service in the base_domain/AdminServer/HelloWorld#1_0 application. Note that the WssUsernameService module name is specified, and the moduleType is set to web.
wls:/base_domain/serverConfig> listWebServicePorts ( '/base_domain/AdminServer/HelloWorld#1_0', 'WssUsernameService','web','{http://namespace/}j2wbasicPolicy') JRFWssUsernamePort http://localhost:7001/j2wbasicPolicy/WssUsername
The following example lists the web service ports and endpoint URLs for the Java EE web service helloWorldJaxws in the wls-domain/AdminServer/helloWorldJaxws application. Note that the moduleType is set to wls.
wls:/wls-domain/serverConfig> listWebServicePorts ('/wls-domain/AdminServer/helloWorldJaxws','helloWorldJaxws#1!helloWorldJaxws', 'wls','helloWorldJaxws')
helloWorldJaxwsSoapHttpPort
Command Category: Web Service and Client Management
Use with WLST: Online
Description
Lists the web service information for an application, SOA composite, or domain. If you do not specify a web service application or a SOA composite, the command lists all services in all applications and composites for every server instance in the domain.
You can specify the amount of information to be displayed in the output using the detail argument. When enabled, the output provides endpoint (port) and policy details for all applications and composites in the domain, the secure status of the endpoints, any configuration overrides and constraints, and if the endpoints have a valid configuration. In addition, the local.policy.reference.source configuration property is provided for each directly attached policy identifying the source of the attachment, as described in "Determining the Source of Policy Attachments" in Securing Web Services and Managing Policies with Oracle Web Services Manager.
A subject is considered secure if the policies attached to it (either directly or globally) enforce authentication, authorization, or message protection behaviors. Because you can specify the priority of a global or directly attached policy (using the reference.priority configuration override), the effective field indicates if the directly attached policies are in effect for the endpoint.
Note that to simplify endpoint management, all directly attached policies are shown in the output regardless of whether they are in effect. In contrast, only globally attached policies that are in effect for the endpoint are displayed. For more information, see "How the Effective Set of Policies is Calculated" in Securing Web Services and Managing Policies with Oracle Web Services Manager.
The output is listed by each application deployed as shown in the following example:
/domain/server/application#version_number:
moduleName=helloModule, moduleType=web, serviceName={http://namespace/}service
/base_domain/AdminServer/soa-infra:
compositeName=default/HelloWorld[1.0], moduleType=soa, serviceName=service
Note:
The listWebServices command output does not include details on SOA components, including policy attachments.
For applications assembled prior to 11g Release 1, (11.1.1.6), the namespace is not displayed with the serviceName in the output.
Syntax
listWebServices (application,composite,[detail])
| Argument | Definition |
|---|---|
|
|
Name and path of the application for which you want to list the web services. For example, If specified, all web services in the application are listed. |
|
|
Name of the SOA composite for which you want to list the Web services. For example, If specified, all Web services in the composite are listed. |
|
|
Optional. Specifies whether to list port and policy details for the web service. For each directly attached policy, the Valid values are:
|
Examples
The following example for an Oracle Infrastructure web service lists all the web services in all applications and composites in the domain. Sample output is shown in this example.
wls:/base_domain/serverConfig> listWebServices()
/base_domain/AdminServer/soa-infra :
compositeName=default/HelloWorld[1.0], moduleType=soa, serviceName=service
compositeName=default/Project1[1.0], moduleType=soa, serviceName=bpelprocess1_client_ep
/base_domain/AdminServer/jaxwsejb30ws :
moduleName=jaxwsejb, moduleType=web, serviceName=JaxwsWithHandlerChainBeanService
moduleName=jaxwsejb, moduleType=web, serviceName=WsdlConcreteService
moduleName=jaxwsejb, moduleType=web, serviceName=EchoEJBService
moduleName=jaxwsejb, moduleType=web, serviceName=CalculatorService
moduleName=jaxwsejb, moduleType=web, serviceName=DoclitWrapperWTJService
The following example for an Oracle Infrastructure web service sets the detail argument to true. Sample output is shown in this example. Security policies are shown in bold text.
Note that the reference priority of the globally attached policy is set to 10 and the directly attached policy is not in effect for the endpoint CalculatorPort in the application jaxwsejb30ws.
Also, note that the local.policy.reference.source configuration property is provided for each directly attached policy identifying the source of the attachment. For more information about the local.policy.reference.source configuration property and a list of valid values, see "Determining the Source of Policy Attachments" in Securing Web Services and Managing Policies with Oracle Web Services Manager.
wls:/base_domain/serverConfig> listWebServices(detail='true') /base_domain/AdminServer/jaxwsejb30ws : moduleName=jaxwsejb, moduleType=web, serviceName=CalculatorService CalculatorPort http://host.example.com:1234/jaxwsejb/Calculator URI="oracle/wss10_saml20_token_with_message_protection_service_policy", category=security, policy-status=enabled; source=global policy set " MyPolicySet1", scope="DOMAIN('*')"; reference-status=enabled; effective=true Property name="reference.priority", value="10" URI="oracle/mex_request_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true Property name="local.policy.reference.source", value="IMPLIED_FEATURE" URI="oracle/mtom_encode_fault_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true Property name="local.policy.reference.source", value="IMPLIED_FEATURE" URI="oracle/max_request_size_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true Property name="local.policy.reference.source", value="IMPLIED_FEATURE" Property name="max.request.size", value="-1" URI="oracle/request_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true Property name="local.policy.reference.source", value="IMPLIED_FEATURE" URI="oracle/soap_request_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true Property name="local.policy.reference.source", value="IMPLIED_FEATURE" URI="oracle/ws_logging_level_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true Property name="logging.level", value="" Property name="local.policy.reference.source", value="IMPLIED_FEATURE" URI="oracle/test_page_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true Property name="local.policy.reference.source", value="IMPLIED_FEATURE" URI="oracle/wsdl_request_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true Property name="local.policy.reference.source", value="IMPLIED_FEATURE" URI="oracle/http_saml20_token_bearer_service_policy", category=security, policy-status=enabled; source=local policy set; reference-status=enabled; reference-status=enabled; effective=false Property name="local.policy.reference.source", value="ANNOTATION" The policy subject is secure in this context.
The following example for a Java EE web service sets the detail argument to true. Sample output is shown in this example. The output lists all the web services in all applications and composites in the domain.
/base_domain/AdminServer/SimpleJAXWS :
moduleName=SimpleJAXWS#1!SimpleEjbService, moduleType=wls, serviceName=SimpleEjbService
SimplePort
URI="oracle/http_basic_auth_over_ssl_service_policy", category=security, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="LOCAL_ATTACHMENT"
The policy subject is secure in this context.
moduleName=SimpleJAXWS#1!SimpleImplService, moduleType=wls, serviceName=SimpleImplService
SimplePort
has Operation level ws-policy
Attached policy or policies are valid; endpoint is not secure.
Note:
This command applies to Oracle Infrastructure web service clients only.
Command Category: Web Service and Client Management
Use with WLST: Online
Description
Configures the set of stub properties of a web service client port for an application or SOA composite.
This command configures or resets all of the stub properties for the OWSM client security policy attached to the client. Each property that you list in the command is set to the value you specify. If a property that was previously set is not explicitly specified in this command, it is reset to the default for the property. If no default exists, the property is removed.
Syntax
setWebServiceClientStubProperties(application, moduleOrCompName, moduleType, serviceRefName, portInfoName, properties)
| Argument | Definition |
|---|---|
|
|
Name and path of the application for which you want to reset the web services client port stub properties. For example, To configure or reset the client port stub properties for an application, this argument is required. |
|
|
Name of the Web module or SOA composite (for example, HelloWorld[1.0]) for which you want to reset the web services client port stub properties. To configure or reset client port stub properties for a SOA composite, the composite name is required (for example, |
|
|
Module type. Valid options are:
|
|
|
Service reference name of the application or SOA composite for which you want to reset the web service client port stub properties. |
|
|
The name of the client port for which you want to reset the stub properties. |
|
|
The list of properties to be set or changed. Properties must be specified using the following format:
For example:
To remove a property or clear the value assigned to it, specify a blank
To remove all the properties of the client port, set this argument to Sample client port stub properties are as follows:
|
Example
The following example resets the client port stub properties ROLE and keystore.recipient.alias to ADMIN and orakey, respectively. Any other properties that were previously set for this client port are either reset to the default or removed. The client port is JRFWssUsernamePort of the WssUsernameClient Web module in the /base_domain/server1/jwsclient_1#1.1.0 application. Note that the moduleType is set to wsconn, and the serviceRefName is set to WssUsernameClient.
wls:/base_domain/serverConfig>setWebServiceClientStubProperties('/base_domain/server1/jwsclient_1#1.1.0', 'WssUsernameClient','wsconn','WssUsernameClient','JRFWssUsernamePort', [("ROLE","ADMIN"),("keystore.recipient.alias","orakey")] )
Command Category: Web Service and Client Management
Use with WLST: Online
Description
Sets, changes, or deletes a single stub property of a web service client port for an application or SOA composite.
Syntax
setWebServiceClientStubProperty(application, moduleOrCompName, moduleType, serviceRefName,portInfoName,propName,[propValue])
| Argument | Definition |
|---|---|
|
|
Name and path of the application for which you want to set the web services client port stub property. For example, To set a client port stub property for an application, this argument is required. |
|
|
Name of the Web module or SOA composite (for example, HelloWorld[1.0]) for which you want to set the web services client port stub property. To set a client port stub property for a SOA composite, the composite name is required (for example, |
|
|
Module type. Valid options are:
|
|
|
Service reference name of the application or SOA composite for which you want to set the web service client port stub property. |
|
|
The name of the client port for which you want to set the stub property. |
|
|
Stub property name that you want to set, change, or delete. For example, |
|
|
Optional. The stub property value, for example, To remove the property, specify a blank |
Example
The following example sets the client port stub property keystore.recipient.alias to the value orakey for the client port JRFWssUsernamePort. The port is a client port of the WssUsernameClient Web module in the /base_domain/server1/jwsclient_1#1.1.0 application. Note that the moduleType is set to wsconn, and the serviceRefName is set to WssUsernameClient.
wls:/base_domain/serverConfig>setWebServiceClientStubProperty ('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn', 'WssUsernameClient','JRFWssUsernamePort','keystore.recipient.alias','orakey')