Specifying Authorization Resource for services.xml¶

Authorization resource for Web Service Operation is to be specified. The authorization resource is specified in URI format.

Please refer to [Authorization Specification Resource Management] for authorization resource URI.

Authorization resource can be set for services or operations.

Authorization resource is specified using <parameter> tag of services.xml. URI of the authorization resource should be specified inside the <parameter name="auth-uri">.

<?xml version="1.0" encoding="UTF-8"?>
<service name="SampleService">
    <description>The Web service on the intra-mart.</description>

    <parameter name="ServiceClass">sample.web_service.provider.SampleService</parameter>

    <module ref="im_ws_auth"/>

    <messageReceivers>
        <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only" class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
        <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"  class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
    </messageReceivers>

    <!-- サービスSampleServiceに対して認可リソースを指定します。 -->
    <parameter name="authz-uri">service://sample/web_service/sample</parameter>
    <operation name="foo">
        <!-- サービスSampleServiceのオペレーションfooに対しての認可リソースを指定します。 -->
        <parameter name="authz-uri">service://sample/web_service/sample/foo</parameter>
    </operation>
    <operation name="bar">
        <!-- サービスSampleServiceのオペレーションbarに対しての認可リソースを指定します。 -->
        <parameter name="authz-uri">service://sample/web_service/sample/bar</parameter>
    </operation>
    <!--
    <operation name="baz">
        <parameter name="authz-uri">service://sample/web_service/sample/baz</parameter>
    </operation>
    -->

</service>

If authorization resources are specified for both service and operation, the one specified for the operation would become valid. For the case described above, the authorization resource URI for operation bar is service://sample/web_service/sample/bar (using operation authorization resource), and the authorization resource URI for operation baz is service://sample/web_service/sample (using service authorization resource).

Warning

If no authorization resource is specified for the service and the operation, the operation authorization would always be [Permitted].

Warning

Authorization is valid only for Web Service that Axis2 Module [im_ws_auth] is applied.

Please refer to [How to apply Axis2 Module [im_ws_auth]] for how to apply Axis2 Module [im_ws_auth].

Warning

Authorization works only when the authorization setting of Web Service Provider is valid.

Please refer to [<enableAuthorization> Tag] of [Web Service Provider Authentication/Authorization Setting] for details.

Warning

If you specified the authorization resource, following error will occur at Web Service Operation execution time when corresponding authorization resource does not exist in the specified URI.

[E.IWP.AUTHZ.DECISION.10007] Resource group is not registered.

Please create the authorization resource in advance when you execute Web Service Operation.

Please refer to [Adding Resources] of 「Setting Authorization in Tenant Administrator Operations Guide] for how to add the authorization resource.

Note

Following format is recommend for URI.

• In case setting it for the service

  service://%Application ID%/web_service/%Service Name%

• In case setting it for Web Service Operation

  service://%Application ID%/web_service/%Service Name%/%Operation Name%

Deployment in Directory Format¶

By placing arbitrary named directory where Web Service materials are stored under %CONTEXT_PATH%/WEB-INF/services directory, you can deploy Web Service.

If you save library, class, property files, WSDL file, XSD file, and services.xml related to Web Service under this directory, Web Service will be deployed.

Path including [services.xml] is as follows.

%CONTEXT_PATH%/WEB-INF/services/%any name%/META-INF/services.xml

Deployment of aar File Format¶

By placing aar file (Asix2 Archive file) in %CONTEXT_PATH%/WEB-INF/services directory, you can deploy Web Service.

aar file is a file where library, class, property file, WSDL file, XSD file, and services.xml related to Web Service are saved.

Please refer to [Creating aar File] for aar file creation.

Please refer to [Apache Axis2 Web Administrator’s Guide Step 3: Create Archive File] of Axis2 project for aar file structure.

Specifying Axis2 Module [im_ws_auth] by services.xml¶

By stating <module ref="im_ws_auth"/> inside the <service> tag, you can specify Axis2 Module [im_ws_auth].

By stating it inside the <operation> tag, you can also specify it for each Web Service Operation.

Please refer to [About services.xml].

Specifying Axis2 Module [im_ws_auth] by axis2.xml¶

Edit %CONTEXT_PATH%/WEB-INF/conf/axis2.xml.

Remove the comment out of <service> tag shown below.

Specify the Web Service name that you want to apply Axis2 Module [im_ws_auth] to <service> tag.

If you want to specify multiple services, please state multiple <service> tags.

<listener class="jp.co.intra_mart.foundation.web_service.axis2.observers.EngageModuleAxisObserver">
    <parameter name="engageModule">
        <module ref="im_ws_auth">
            <!-- <service>ExampleWebServiceName</service> -->
        </module>
    </parameter>
</listener>

Specifying Axis2 Module [im_ws_auth] by Apache Axis2 Administration Console¶

You can also apply Axis2 Module [im_ws_auth] by using administration console function of Apache Axis2.

Please refer to [About Apache Axis2 Administration Console] for administration console.

1. Access the one below for the server in operation.

   http://<HOST>:<PORT>/<CONTEXT_PATH>/axis2-web/index.jsp

   

2. Click [Administration].

3. Click [For a service] in Engage module.

   

4. Select [im_ws_auth] in Select a Module:, and select any service in Select a Service:.

   

5. Click [Engage].

6. Axis2 Module [im_ws_auth] would be applied for the service you specified in the above.

Warning

For the Axis2 Module that uses administration console, settings would be initialized if you restart the application server.

Monitoring by TCPMon¶

How to use message monitoring tool [TCPMon] provided in Apache Web Services Project is introduced.

Please refer to [TCPMon] for the details about TCPMon.

1. TCPMon Download and Decompression

Download TCPMon from [TCPMon Download Page] and decompress the archive. This directory is %TCPMON_HOME%.

1. TCPMon Startup and Setting

   Execute %TCPMON_HOME%/build/tcpmon.bat (or tcpmon.sh) and start TCPMon.
   Display [Admin] tab and set appropriate port number to Listen Port. When you specify the port number, it should not overlap with the one of other services.

   In this document, it is specified to [9999] as an example.
   Set the host information where the Eb service is to be deployed to Target Hostname and Target Port.

   In this document, Target Hostname is [localhost] and Target Port is [8080] as an example.
   After that, click [Add].
   

2. Change end point by Web Service Client.

   Change the end point port number to be specified by Web Service Client at execution time to Listen Port., which you have specified before.

   Note

   If Script Development Model API SOAPClient is used, you should change the port number that you have specified in the end point of the 4th argument of SOAPClient to the port number of Listen Port.

   Note

   If you have generated the stub from WSDL, please change the port number specified in the end point specified by the stub constructor to the port number of Listen Port.

3. View the SOAP messages from [Port <Port Number of Listen Port>] tab.