This documentation is for WSO2 Application Server 5.2.0. View documentation for the latest release.
Invoking Applications RESTfully - Application Server 5.2.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

This sample demonstrates the WSO2 Application Server's ability to generate code for a WSDL 2.0 description and its ability to invoke a real world application RESTfully. The WSDL describes the REST API of Flickr via HTTPBinding  of WSDL 2.0. The Client provided in the sample uses a stub that is dynamically generated by the Application Server.

Building the sample

The  FlickrClient sample is located in <AS_HOME>/samples/FlickrClient directory.

For more information, see Building Axis2 Samples.

The build dynamically generates a stub using the WSDL 2.0 description and opens the Client.

Interacting with Flickr

  1. To contibue you need to provide an API key obtained from Flickr. The API key will be used for subsequent invocations of the Flickr API. If you do not have have an API key, you can apply for one from http://www.flickr.com/services/api/keys/apply
  2. The application can be configured using the configure menu using the following properties:
    • Host - Can be used to change the host address, the requests are sent to (Useful if you want to track the wire messages. e.g., tcp monitor).
    • Port - Can be used to change the port, the requests are sent to (Useful if you want to track the wire messages. e.g., tcp monitor).
    • API KEY - Used to change the API KEY provided.
    • Secret - Used to change the shared secret provided.

  3. Each main tab in the application corresponds to a category of methods specified in the Flickr API.
    For example, the people tab corresponds to the people category while the PhotoSetsComments tab corresponds to the photosets.comments category.
  4. Each sub tab in the application, corresponds to a single method specified in the Flickr API under the main category. For example, the FindByEmail tab corresponds to the flickr.people.findByEmail method defined under the people category; while the PhotoSetsComments tab corresponds to the photosets.comments category.

Flickr Authorization

Many methods on Flickr require the user to be logged in. When such a method is accessed, the application shows a dialog box stating that authorization is required to proceed.

If you click the Yes button in the dialog box, the application will authorize using the relevant Flickr API. If you are not currently logged into Flickr, you will be asked to do so first. It always requests only the permission needed to fulfill a particular request. If the application does not have sufficient permission when another operation is attempted, it may require you to grant permission again.

There are three levels of permission.

  • read - permission to read private information.
  • write - permission to add, edit and delete photo metadata (includes 'read').
  • delete - permission to delete photos (includes 'write' and 'read').

The WSDL for the FlickrClient can be found here: <AS_HOME>/samples/FlickrClient/wsdl

  • No labels