io.vertigo.social.webservices.account

Class AccountWebServices

java.lang.Object

io.vertigo.social.webservices.account.AccountWebServices

All Implemented Interfaces:

io.vertigo.core.component.Component, io.vertigo.vega.webservice.WebServices

@PathPrefix(value="/x/accounts")
public final class AccountWebServices
extends Object
implements io.vertigo.vega.webservice.WebServices

Webservices for account extension.

Author:

npiedeloup

Constructor Summary

Constructors

Constructor and Description
AccountWebServices()

Method Summary

Modifier and Type	Method and Description
io.vertigo.account.account.Account	getAccount(String id) Gets an account by its id.
io.vertigo.account.account.AccountGroup	getAccountGroup(String id) Gets a group by its id.
io.vertigo.dynamo.file.model.VFile	getAccountPhoto(String id) Gets an account photo by its id.
Map<String,Object>	getConfig() Extension config.
String	getHelp() Extension help.
Map<String,Object>	getStats() Extension stats.
String	getStatus() Extension status (code 200 or 500)

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountWebServices

public AccountWebServices()

Method Detail

getAccount

@GET(value="/api/{id}")
 @AnonymousAccessAllowed
public io.vertigo.account.account.Account getAccount(@PathParam(value="id")
                                                                                                        String id)

Gets an account by its id.

Parameters:

id - the account id.

Returns:

the account

getAccountPhoto

@GET(value="/api/{id}/photo")
 @AnonymousAccessAllowed
public io.vertigo.dynamo.file.model.VFile getAccountPhoto(@PathParam(value="id")
                                                                                                                   String id)

Gets an account photo by its id.

Parameters:

id - account id.

Returns:

the photo of an account

getAccountGroup

@GET(value="/api/groups/{id}")
 @AnonymousAccessAllowed
public io.vertigo.account.account.AccountGroup getAccountGroup(@PathParam(value="id")
                                                                                                                         String id)

Gets a group by its id.

Parameters:

id - the group id.

Returns:

the group

getStatus

@GET(value="/infos/status")
 @AnonymousAccessAllowed
public String getStatus()

Extension status (code 200 or 500)

Returns:

"OK" or error message

getStats

@GET(value="/infos/stats")
 @AnonymousAccessAllowed
public Map<String,Object> getStats()

Extension stats.

Returns:

"OK" or error message

getConfig

@GET(value="/infos/config")
 @AnonymousAccessAllowed
public Map<String,Object> getConfig()

Extension config.

Returns:

Config object

getHelp

@GET(value="/infos/help")
 @AnonymousAccessAllowed
public String getHelp()

Extension help.

Returns:

Help object