Summary: Methods | [Expand All]
public interface

JiveFacade

org.mule.modules.jive.JiveFacade
Known Indirect Subclasses

Class Overview

Facade for the Jive connector.

Summary

Public Methods
abstract Long count(EntityType type)
Get count method.
abstract Map<String, Object> create(EntityType type, Map<String, Object> entity)
Creates an entity.
abstract Map<String, Object> delete(EntityType type, String id)
Deletes an entity.
abstract Map<String, Object> execute(CustomOp customType, Map<String, Object> entity, String id)
Executes a POST CustomOp.
abstract Map<String, Object> get(EntityType entityType, String id)
Executes a get request with the given id as path params for the given EntityType
abstract Long getUserID()
Make a request for the userID to the jive server for the given username and password.
abstract void setGatewayUri(String gatewayUri)
Sets the gatewayUri to be used as base url for the rest server
abstract void setPassword(String pass)
Sets the jive password
abstract void setUsername(String user)
Sets the jive username
abstract Map<String, Object> update(EntityType entityType, Map<String, Object> entity)
Executes a put method for the given EntityType sending as payload the given entity.

Public Methods

public abstract Long count (EntityType type)

Get count method.

Parameters
type The entity type to count
Returns
  • The count of the EntityType returned by the server as Long

public abstract Map<String, Object> create (EntityType type, Map<String, Object> entity)

Creates an entity. Sends a POST request for the given EntityType generating the xml payload corresponding with the entity map.

Parameters
type The service type used to determine the url for this resource.
entity The Map with the entity data to parse to an xml and send in the request.
Returns
  • The xml response parse in a Map.

public abstract Map<String, Object> delete (EntityType type, String id)

Deletes an entity.

Parameters
type The service type used to determine the url for this resource.
id The id to be added in the url as path parameter.
Returns
  • The xml response parse in a Map.

public abstract Map<String, Object> execute (CustomOp customType, Map<String, Object> entity, String id)

Executes a POST CustomOp.

Parameters
customType The service to execute, used to determine the resource url, the http protocol to use and, if needed, the root tag for the xml to be send in the request.
entity The Map with the entity data to parse to an xml and send in the request.
id
Returns
  • The xml response parse in a Map.

public abstract Map<String, Object> get (EntityType entityType, String id)

Executes a get request with the given id as path params for the given EntityType

Parameters
entityType The entity type
id The path params to add to the resource uri
Returns
  • The server response as a Map

public abstract Long getUserID ()

Make a request for the userID to the jive server for the given username and password.

Returns
  • The jive userID

public abstract void setGatewayUri (String gatewayUri)

Sets the gatewayUri to be used as base url for the rest server

Parameters
gatewayUri

public abstract void setPassword (String pass)

Sets the jive password

Parameters
pass

public abstract void setUsername (String user)

Sets the jive username

Parameters
user

public abstract Map<String, Object> update (EntityType entityType, Map<String, Object> entity)

Executes a put method for the given EntityType sending as payload the given entity.

Parameters
entityType The entity type
entity The data to be send as payload in the request
Returns
  • The server response as a Map