co.codewizards.cloudstore.rest.server.service

Class AbstractServiceWithRepoToRepoAuth

java.lang.Object

co.codewizards.cloudstore.rest.server.service.AbstractServiceWithRepoToRepoAuth

Direct Known Subclasses:

BeginPutFileService, ChangeSetDTOService, CopyService, EndPutFileService, EndSyncFromRepositoryService, EndSyncToRepositoryService, MakeDirectoryService, MakeSymlinkService, MoveService, RepoFileDTOService, WebDavService

public abstract class AbstractServiceWithRepoToRepoAuth
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	repositoryName
protected javax.servlet.http.HttpServletRequest	request

Constructor Summary

Constructors

Constructor and Description
AbstractServiceWithRepoToRepoAuth()

Method Summary

Methods

Modifier and Type	Method and Description
protected RepoTransport	authenticateAndCreateLocalRepoTransport()
protected URL	authenticateAndGetLocalRootURL()
protected String	authenticateAndReturnUserName() Get the Auth information via getAuth() and verify, if they are valid.
protected Auth	getAuth() Get the authentication information.
protected UUID	getClientRepositoryIdFromUserName(String userName)
protected UUID	getClientRepositoryIdFromUserNameOrFail(String userName)
protected URL	getLocalRootURL(UUID clientRepositoryId)

Methods inherited from class java.lang.Object

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

Field Detail

request

@Context
protected javax.servlet.http.HttpServletRequest request

repositoryName

@PathParam(value="repositoryName")
protected String repositoryName

Constructor Detail

AbstractServiceWithRepoToRepoAuth

public AbstractServiceWithRepoToRepoAuth()

Method Detail

getAuth

protected Auth getAuth()
                throws javax.ws.rs.WebApplicationException

Get the authentication information. This method does not verify, if the given authentication information is correct! It merely checks, if the client sent a 'Basic' authentication header. If it did not, this method throws a WebApplicationException with Response.Status.UNAUTHORIZED or Response.Status.FORBIDDEN. If it did, it extracts the information and puts it into an Auth instance.

Returns:

the Auth instance extracted from the client's headers. Never null.

Throws:

javax.ws.rs.WebApplicationException - with Response.Status.UNAUTHORIZED, if the client did not send an 'Authorization' header; with Response.Status.FORBIDDEN, if there is an 'Authorization' header, but no 'Basic' authentication header (other authentication modes, like e.g. 'Digest' are not supported).

authenticateAndReturnUserName

protected String authenticateAndReturnUserName()
                                        throws javax.ws.rs.WebApplicationException

Get the Auth information via getAuth() and verify, if they are valid.

Returns:

the Auth information via getAuth(); never null.

Throws:

javax.ws.rs.WebApplicationException - with Response.Status.UNAUTHORIZED, if the client did not send an 'Authorization' header or if user-name / password is wrong; with Response.Status.FORBIDDEN, if there is an 'Authorization' header, but no 'Basic' authentication header (other authentication modes, like e.g. 'Digest' are not supported); with Response.Status.INTERNAL_SERVER_ERROR, if there was an IOException.

getClientRepositoryIdFromUserName

protected UUID getClientRepositoryIdFromUserName(String userName)

getClientRepositoryIdFromUserNameOrFail

protected UUID getClientRepositoryIdFromUserNameOrFail(String userName)

authenticateAndCreateLocalRepoTransport

protected RepoTransport authenticateAndCreateLocalRepoTransport()

authenticateAndGetLocalRootURL

protected URL authenticateAndGetLocalRootURL()

getLocalRootURL

protected URL getLocalRootURL(UUID clientRepositoryId)