org.apache.hadoop.chukwa.datacollection.agent.rest

Class AdaptorController

java.lang.Object

org.apache.hadoop.chukwa.datacollection.agent.rest.AdaptorController

public class AdaptorController
extends Object

JAX-RS controller to handle all HTTP request to the Agent that deal with adaptors.

Constructor Summary

Constructors

Constructor and Description
AdaptorController()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addAdaptor(AdaptorConfig ac) Adds an adaptor to the agent and returns the adaptor info
javax.ws.rs.core.Response	getAdaptor(String adaptorId) Get a single adaptor
javax.ws.rs.core.Response	getAdaptors() Get all adaptors
javax.ws.rs.core.Response	removeAdaptor(String adaptorId) Remove an adaptor from the agent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdaptorController

public AdaptorController()

Method Detail

addAdaptor

public javax.ws.rs.core.Response addAdaptor(AdaptorConfig ac)

Adds an adaptor to the agent and returns the adaptor info

Parameters:

ac - is adaptor configuration

Returns:

web status

response.representation.200.doc

Adaptor has been registered

response.representation.200.mediaType

application/json

response.representation.200.example

Examples.ADAPTOR_STATUS_SAMPLE

response.representation.400.doc

Error in register adaptor

response.representation.400.mediaType

text/plain

response.representation.400.example

Bad Request

request.representation.example

Examples.CREATE_ADAPTOR_SAMPLE

removeAdaptor

public javax.ws.rs.core.Response removeAdaptor(String adaptorId)

Remove an adaptor from the agent

Parameters:

adaptorId - id of adaptor to remove.

Returns:

web status

response.representation.200.doc

Delete adaptor by id

response.representation.200.mediaType

text/plain

getAdaptors

public javax.ws.rs.core.Response getAdaptors()

Get all adaptors

Returns:

web status

response.representation.200.doc

List all configured adaptors

response.representation.200.mediaType

application/json

response.representation.200.example

Examples.ADAPTOR_LIST_SAMPLE

getAdaptor

public javax.ws.rs.core.Response getAdaptor(String adaptorId)

Get a single adaptor

Parameters:

adaptorId - id of the adaptor to return

Returns:

web status

response.representation.200.doc

Adaptor status and data transfer rate in 1, 5, 10 minutes averages

response.representation.200.mediaType

application/json

response.representation.200.example

Examples.ADAPTOR_STATUS_SAMPLE