getClientDynamicPolicyControl command

Use the getClientDynamicPolicyControl command to find out whether an application that is a web service client obtains the policy configuration of a web service provider, and to list the properties that apply to obtaining that configuration.

To run the command, use the AdminTask object of the wsadmin scripting client.

[IBM i]The wsadmin scripting client is run from Qshell. For more information, see the topic about configuring Qshell to run product scripts.

This command is valid only when it is used with WebSphere® Application Server Version 7 and later application servers. Do not use it with earlier versions.

For a list of the available policy set management administrative commands, plus a brief description of each command, enter the following command at the wsadmin prompt:

print AdminTask.help('PolicySetManagement')

For overview help on a given command, enter the following command at the wsadmin prompt:

print AdminTask.help('command_name')

After using the command, save your changes to the master configuration. For example, use the following command:

AdminConfig.save()

Purpose

Use the getClientDynamicPolicyControl command to find out how an application, or a service in an application, obtains the policy configuration of a service provider. The client can obtain the policy configuration of the provider through a Web Services Metadata Exchange (WS-MetadataExchange) request or through an HTTP GET request.

Target object

None.

Required parameters

-applicationName
The name of the application for which you want to find out how it obtains the policy configuration of a service provider. The application must be a service client. (String)

Optional parameters

-resource
The name of the resource for which you want to find out how it obtains the policy configuration of a service provider. If you specify this parameter, only the properties for that resource are returned. To retrieve information for the application, specify WebService:/. Alternatively, you can specify a service, a service reference, an endpoint, or an operation. (String)
For further details, see the topic Configuring the client policy to use a service provider policy by using wsadmin scripting.

Return value

Returns a list of properties that include the resource name and that show how it obtains the policy configuration of a service provider. The following properties can be returned:
httpGetTargetURI
The target URL of the HTTP GET request. This property is returned if the value of the acquireProviderPolicyMethod property is httpGet.
httpGetPolicySetName
The system policy set that contains the HTTP and SSL transport policy to use for the HTTP GET request. This property is returned if the httpGetTargetURI property has a value.
httpGetPolicySetBinding
The general binding that contains the HTTP and SSL transport bindings for the HTTP GET request. This property is returned if the httpGetTargetURI property has a value.
wsMexPolicySetName
The name of the policy set that specifies message-level security when the resource shares its policy configuration through a WS-MetadataExchange request. This property is returned if the value of the acquireProviderPolicyMethod property is wsMex and a policy set to provide message-level security was specified.
wsMexPolicySetBinding
The name of the binding that is used when the resource shares its policy configuration through a WS-MetadataExchange request. This property is returned if the value of the acquireProviderPolicyMethod property is wsMex and a binding to provide message-level security was specified.
acquireProviderPolicyMethod
How the policy configuration of the provider can be obtained. Valid values for this property are:
wsMex
The resource can obtain the policy configuration of a service provider through a WS-MetadataExchange request.
httpGet
The resource can obtain the policy configuration of a service provider through an HTTP GET request.
resource
The resource that you specified.
directSetting
How the properties apply to the resource. Valid values for this property are:
true
The properties apply directly to the resource.
false
The properties are inherited from the parent application or service.

Examples

The following example displays the properties that control how the EchoService service of the WSPolicyClient application obtains the policy configuration of a service provider. The client is configured to retrieve the provider policy through a WS-MetadataExchange request with message-level security, by using the SystemWSSecurityDefault policy set and the Client sample general binding.

AdminTask.getClientDynamicPolicyControl(['-applicationName', 'WSPolicyClient', 
'-resource', 'WebService:/WSPClient.war:{http://example_path/}EchoService'])
.
.
[ [wsMexPolicySetName SystemWSSecurityDefault] [wsMexPolicySetBinding [Client sample]] 
[acquireProviderPolicyMethod [wsMex]] 
[resource WebService:/WSPClient.war:{http://example_path/}EchoService/] 
[directSetting true] ]

The following example displays the properties that control how the EchoService service of the WSPolicyClient application obtains the policy configuration of a service provider when the client is configured to retrieve the provider policy through an HTTP GET request.

AdminTask.getClientDynamicPolicyControl(['-applicationName', 'WSPolicyClient', 
'-resource', 'WebService:/WSPClient.war:{http://example_path/}EchoService'])
.
.
[ [httpGetTargetURI http://example_path/EchoService?wsdl] 
[acquireProviderPolicyMethod [httpGet]] 
[resource WebService:/WSPClient.war:{http://example_path/}EchoService/] 
[directSetting true] ]