Code Monkey home page Code Monkey logo

drupal-services-api's Introduction

Drupal Services API Client (Java)

This library is an easy-to-use Java client library for accessing the Drupal Services REST Server API.

Introduction

This library makes use of Retrofit as a REST client. For more information visit the Retrofit website.


The RestAdapter class generates an implementation of a resource interface.

RestAdapter restAdapter = new RestAdapter.Builder()
        .setEndpoint("http://127.0.0.1/endpoint") // Service endpoint
        .build();

NodeResourceForm resource = restAdapter.create(NodeResourceForm.class);

Each call on a generated resource makes an HTTP request to the webserver.

Map<String, String> params = new LinkedHashMap<String, String>();

params.put("pagesize", "10"); // Number of items to be returned
params.put("page", "2"); // Page number of results to return
params.put("fields", "id,title"); // Fields you want returned
params.put("parameters[\"type\"]", "article"); // Values used to filter results
params.put("parameters[\"status\"]", "1"); // ...

List<NodeEntity> nodes = resource.index("node", params);

Sessions

The SessionInterceptor class inserts a session header, and CSRF token.

SessionInterceptor interceptor = new SessionInterceptor();

RestAdapter restAdapter = new RestAdapter.Builder()
        .setEndpoint("http://127.0.0.1/endpoint") // Service endpoint
        .setRequestInterceptor(interceptor)
        .build();

UserResourceForm resource = restAdapter.create(UserResourceForm.class);

UserEntity user = new UserEntity()
        .setName("random") // Username
        .setPass("hackme"); // Password

Map<String, String> params = new EntityConverter<UserEntity>().convert(user);

SessionEntity session = resource.login("user", params);

// Requests now carry a session/token
interceptor
        .setSessionId(session.getId())
        .setSessionName(session.getName())
        .setCsrfToken(session.getCsrf());

When done.

// Logout of Drupal (invalidate session)
resource.logout("user");

// Clear SessionInterceptor 
interceptor
        .setSessionId(null)
        .setSessionName(null)
        .setCsrfToken(null);

*ResourceForm, and *ResourceJson

TODO: Explain Retrofit, GSON, and Drupal Services REST Server API limits.

Files

TODO: Add example.

drupal-services-api's People

Contributors

rwanyoike avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

eebanos huokedu

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.