Package org.silverpeas.core.webapi.password

Class PasswordResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.password.AbstractPasswordResource

org.silverpeas.core.webapi.password.PasswordResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("password")
@Authenticated
public class PasswordResource
extends AbstractPasswordResource

A REST Web resource giving gallery data.

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

Modifier and Type	Field	Description
protected static int	nbMatchingCombinedRules
protected static org.silverpeas.kernel.bundle.SettingBundle	settings

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
PasswordResource()

Method Summary

Modifier and Type	Method	Description
PasswordCheckEntity	checking(PasswordEntity password)	Gets the JSON representation of a list of errors catched by a password checking.
PasswordPolicyEntity	getPolicy()	Gets the JSON representation of password policy.
protected String	getResourceBasePath()	Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().
void	validateUserAuthentication(UserPrivilegeValidation validation)	User authentication is not necessary for this WEB Service.

Methods inherited from class org.silverpeas.core.webapi.password.AbstractPasswordResource

asWebEntity, asWebEntity, getComponentId, getLanguage

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService

createWebResourceUri, 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

Field Detail

settings

protected static org.silverpeas.kernel.bundle.SettingBundle settings

nbMatchingCombinedRules

protected static int nbMatchingCombinedRules

Constructor Detail

PasswordResource

public PasswordResource()

Method Detail

getResourceBasePath

protected String getResourceBasePath()

Description copied from class: RESTWebService

Gets the base path of the web resource relative to the root path of all 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.

validateUserAuthentication

public void validateUserAuthentication(UserPrivilegeValidation validation)
                                throws javax.ws.rs.WebApplicationException

User authentication is not necessary for this WEB Service. The authentication processing is used here to identify the user behind the call if possible.

Parameters:

validation - the validation instance to use.

Throws:

javax.ws.rs.WebApplicationException - if an error occurs

See Also:

UserPrivilegeValidator

getPolicy

@GET
@Path("policy")
@Produces({"application/json","application/xml"})
public PasswordPolicyEntity getPolicy()

Gets the JSON representation of password policy. If it doesn't exist, a 404 HTTP code is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.

Returns:

the response to the HTTP GET request with the JSON representation of the asked photo.

checking

@POST
@Path("policy/checking")
@Consumes("application/json")
@Produces("application/json")
public PasswordCheckEntity checking(PasswordEntity password)

Gets the JSON representation of a list of errors catched by a password checking. The returned list contains names of rules which are not verified. If it doesn't exist, a 404 HTTP code is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.

Returns:

the response to the HTTP GET request with the JSON representation of the asked photo.