AbstractPasswordResource (Silverpeas Core 6.4 API)

java.lang.Object
- org.silverpeas.core.web.rs.RESTWebService
- - org.silverpeas.core.webapi.password.AbstractPasswordResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

Direct Known Subclasses:

PasswordResource
```
public abstract class AbstractPasswordResource
extends RESTWebService
```
Author:

Yohann Chastagnier

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

AbstractPasswordResource()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected PasswordRuleEntity`	`asWebEntity(PasswordRule rule)`	Converts the password rule into its corresponding web entity.
`protected PasswordCheckEntity`	`asWebEntity(PasswordCheck check)`	Converts the password check into its corresponding web entity.
`String`	`getComponentId()`	Gets the identifier of the component instance to which the requested resource belongs to.
`protected String`	`getLanguage()`	Due to the particularity of this WEB Service according to authentication, the language is handled at this level.

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService
createWebResourceUri, fromPage, getBundle, getBundleLocation, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getResourceBasePath, 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
  - AbstractPasswordResource
```
public AbstractPasswordResource()
```
- Method Detail
  - 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.
  - asWebEntity
```
protected PasswordRuleEntity asWebEntity(PasswordRule rule)
```
    Converts the password rule into its corresponding web entity.
    
    Parameters:
    
    rule - the password rule.
    
    Returns:
    
    the corresponding password rule entity.
  - asWebEntity
```
protected PasswordCheckEntity asWebEntity(PasswordCheck check)
```
    Converts the password check into its corresponding web entity.
    
    Parameters:
    
    check - the password check.
    
    Returns:
    
    the corresponding password check entity.
  - getLanguage
```
protected String getLanguage()
```
    Due to the particularity of this WEB Service according to authentication, the language is handled at this level.
    
    Returns:
    
    the language code