RelationResource (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.web.rs.RESTWebService
- - org.silverpeas.core.webapi.socialnetwork.RelationResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource
```
@RequestScoped
@Path("relations")
@Authenticated
public class RelationResource
extends RESTWebService
```
It represents a resource published in the WEB that represents the relationship of a user.
The WEB resource belongs always to the current user in the session underlying at the HTTP request.

Nested Class Summary
- Nested classes/interfaces inherited from class org.silverpeas.core.web.rs.RESTWebService
  RESTWebService.WebProcess<R>, RESTWebService.WebTreatment<R>

Field Summary
- Fields inherited from class org.silverpeas.core.web.rs.RESTWebService
  RESPONSE_HEADER_ARRAYSIZE
- Fields inherited from interface org.silverpeas.core.web.SilverpeasWebResource
  BASE_PATH

Constructor Summary

Constructors
Constructor Description

RelationResource()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`javax.ws.rs.core.Response`	`deleteRelation(String userId)`
`String`	`getComponentId()`	Gets the identifier of the component instance to which the requested resource belongs to.
`protected String`	`getResourceBasePath()`	Gets the base path of the web resource relative to the root path of all of the web resources in Silverpeas as given by `SilverpeasWebResource.getBasePath()`.

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService
fromPage, getBundle, getBundleLocation, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getSilverpeasContext, getUri, getUser, getUserPreferences, getUserRoles, identifiedBy, identifiedBy, initContext, initWebResourceUri, isUserDefined, process

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.silverpeas.core.web.rs.ProtectedWebResource
validateUserAuthorization

Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation
validateUserAuthentication

- Constructor Detail
  - RelationResource
```
public RelationResource()
```
- Method Detail
  - deleteRelation
```
@DELETE
@Path("{userId}")
@Produces("application/json")
public javax.ws.rs.core.Response deleteRelation(@PathParam("userId")
                                                String userId)
```
  - getResourceBasePath
```
protected String getResourceBasePath()
```
    Description copied from class: RESTWebService
    
    Gets the base path of the web resource relative to the root path of all of the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().
    
    Specified by:
    
    getResourceBasePath in class RESTWebService
    
    Returns:
    
    the relative path that identifies this REST web service among all other REST web services.
  - getComponentId
```
public String getComponentId()
```
    Description copied from interface: SilverpeasWebResource
    
    Gets the identifier of the component instance to which the requested resource belongs to.
    
    Returns:
    
    the identifier of the Silverpeas component instance.