org.das2.util.filesystem

Interface WebProtocol

All Known Implementing Classes:

AppletHttpProtocol, DefaultHttpProtocol, WGetWebProtocol

public interface WebProtocol

template for web-based protocols to implement FileSystems

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTTP_RESPONSE_CODE kludge in place where the response code (200,302,401,etc) can be stored.
static java.lang.String	META_CONTENT_LENGTH
static java.lang.String	META_CONTENT_TYPE
static java.lang.String	META_COOKIE
static java.lang.String	META_ETAG
static java.lang.String	META_EXIST
static java.lang.String	META_LAST_MODIFIED

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getInputStream(WebFileObject fo, ProgressMonitor mon) get an inputStream for the resource.
java.util.Map<java.lang.String,java.lang.String>	getMetadata(WebFileObject fo) return metadata for the resource.

Field Detail

META_EXIST

static final java.lang.String META_EXIST

See Also:

Constant Field Values

META_COOKIE

static final java.lang.String META_COOKIE

See Also:

Constant Field Values

META_LAST_MODIFIED

static final java.lang.String META_LAST_MODIFIED

See Also:

Constant Field Values

META_CONTENT_LENGTH

static final java.lang.String META_CONTENT_LENGTH

See Also:

Constant Field Values

META_CONTENT_TYPE

static final java.lang.String META_CONTENT_TYPE

See Also:

Constant Field Values

META_ETAG

static final java.lang.String META_ETAG

See Also:

Constant Field Values

HTTP_RESPONSE_CODE

static final java.lang.String HTTP_RESPONSE_CODE

kludge in place where the response code (200,302,401,etc) can be stored.

See Also:

Constant Field Values

Method Detail

getInputStream

java.io.InputStream getInputStream(WebFileObject fo,
                                   ProgressMonitor mon)
                            throws java.io.IOException

get an inputStream for the resource. The client using the stream must make sure the stream is closed.

Parameters:

fo - the resource

mon - monitor for the stream.

Returns:

the stream

Throws:

java.io.IOException

getMetadata

java.util.Map<java.lang.String,java.lang.String> getMetadata(WebFileObject fo)
                                                      throws java.io.IOException

return metadata for the resource. This should include:

• WebProtocol.META_EXIST, "true" or "false"
• WebProtocol.META_LAST_MODIFIED, String.valueOf( fo.localFile.lastModified() )
• WebProtocol.META_CONTENT_LENGTH, String.valueOf( fo.localFile.length() )
• WebProtocol.META_CONTENT_TYPE, Files.probeContentType( fo.localFile.toPath() ) )

Parameters:

fo - the resource

Returns:

Throws:

java.io.IOException