com.github.jinahya.simple.file.front

Class AbstractLocatorsResource

java.lang.Object

com.github.jinahya.simple.file.front.AbstractLocatorsResource

public abstract class AbstractLocatorsResource
extends Object

Author:

Jin Kwon <jinahya_at_gmail.com>

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFERRED_PATH_VALUE

Constructor Summary

Constructors

Constructor and Description
AbstractLocatorsResource()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	copySingle(com.github.jinahya.simple.file.back.FileContext fileContext, String sourceLocator, String targetLocator, boolean distributeFlag)
javax.ws.rs.core.Response	copySingle(String sourceLocator, String targetLocator, boolean distribute)
javax.ws.rs.core.Response	deleteSingle(String locator, boolean distribute)
protected com.github.jinahya.simple.file.back.FileBack	getFileBack() Returns the injected backing.
protected List<URI>	getFileFronts() Returns the injected siblings.
protected static ByteBuffer	key(String locator)
protected javax.ws.rs.core.Response	readSingle(com.github.jinahya.simple.file.back.FileContext fileContext, String sourceLocator)
javax.ws.rs.core.Response	readSingle(String locator)
protected javax.ws.rs.core.Response	updateSingle(com.github.jinahya.simple.file.back.FileContext fileContext, String targetLocator, InputStream sourceStream, boolean distributeFlag)
javax.ws.rs.core.Response	updateSingle(String locator, boolean distribute, InputStream entity)

Methods inherited from class java.lang.Object

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

Field Detail

PREFERRED_PATH_VALUE

public static final String PREFERRED_PATH_VALUE

See Also:

Constant Field Values

Constructor Detail

AbstractLocatorsResource

public AbstractLocatorsResource()

Method Detail

key

protected static ByteBuffer key(String locator)

copySingle

protected javax.ws.rs.core.Response copySingle(com.github.jinahya.simple.file.back.FileContext fileContext,
                                               String sourceLocator,
                                               String targetLocator,
                                               boolean distributeFlag)
                                        throws IOException,
                                               com.github.jinahya.simple.file.back.FileBackException

Throws:

IOException

com.github.jinahya.simple.file.back.FileBackException

copySingle

@POST
 @Path(value="/{locator: .+}/copy")
public javax.ws.rs.core.Response copySingle(@PathParam(value="locator")
                                                                                      String sourceLocator,
                                                                                      @QueryParam(value="locator")
                                                                                      String targetLocator,
                                                                                      @QueryParam(value="distribute") @DefaultValue(value="true")
                                                                                      boolean distribute)
                                                                               throws IOException,
                                                                                      com.github.jinahya.simple.file.back.FileBackException

Throws:

IOException

com.github.jinahya.simple.file.back.FileBackException

deleteSingle

@DELETE
 @Path(value="{locator: .+}")
public javax.ws.rs.core.Response deleteSingle(@PathParam(value="locator")
                                                                                    String locator,
                                                                                    @QueryParam(value="distribute") @DefaultValue(value="true")
                                                                                    boolean distribute)
                                                                             throws IOException,
                                                                                    com.github.jinahya.simple.file.back.FileBackException

Parameters:

locator -

distribute -

Returns:

Throws:

IOException - if an I/O error occurs.

com.github.jinahya.simple.file.back.FileBackException - if a file back error occurs.

See Also:

FileBack.operate(com.github.jinahya.simple.file.back.FileContext)

readSingle

protected javax.ws.rs.core.Response readSingle(com.github.jinahya.simple.file.back.FileContext fileContext,
                                               String sourceLocator)
                                        throws IOException,
                                               com.github.jinahya.simple.file.back.FileBackException

Throws:

IOException

com.github.jinahya.simple.file.back.FileBackException

readSingle

@Produces(value="*/*")
 @GET
 @Path(value="{locator: .+}")
public javax.ws.rs.core.Response readSingle(@PathParam(value="locator")
                                                                                                       String locator)
                                                                                                throws IOException,
                                                                                                       com.github.jinahya.simple.file.back.FileBackException

Parameters:

locator - the file locator.

Returns:

a response.

Throws:

IOException - if an I/O error occurs.

com.github.jinahya.simple.file.back.FileBackException - if a file back error occurs.

updateSingle

protected javax.ws.rs.core.Response updateSingle(com.github.jinahya.simple.file.back.FileContext fileContext,
                                                 String targetLocator,
                                                 InputStream sourceStream,
                                                 boolean distributeFlag)

updateSingle

@Consumes(value="*/*")
 @PUT
 @Path(value="{locator: .+}")
public javax.ws.rs.core.Response updateSingle(@PathParam(value="locator")
                                                                                                         String locator,
                                                                                                         @QueryParam(value="distribute") @DefaultValue(value="true")
                                                                                                         boolean distribute,
                                                                                                         InputStream entity)
                                                                                                  throws IOException,
                                                                                                         com.github.jinahya.simple.file.back.FileBackException

Parameters:

locator - file locator

distribute - distribute flag

entity - the entity to update.

Returns:

a response

Throws:

IOException - if an I/O error occurs.

com.github.jinahya.simple.file.back.FileBackException - if a file back error occusr.

See Also:

FileBack.operate(com.github.jinahya.simple.file.back.FileContext)

getFileBack

protected com.github.jinahya.simple.file.back.FileBack getFileBack()

Returns the injected backing.

Returns:

the injected backing.

getFileFronts

protected List<URI> getFileFronts()

Returns the injected siblings.

Returns:

the injected siblings.