Interface FileContentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface FileContentSession
extends OsidSession

This session defines methods forreading and writing files. The directory associated with this session is the current working directory and any relative path names provided are with respect to this directory.

Method Summary

Modifier and Type	Method	Description
boolean	canReadFiles()	Tests if this user can access files in this directory.
boolean	canWriteFiles()	Tests if this user can update this file.
DataInputStream	getBlockingInputStream(String name)	Gets the input stream for reading this file.
Directory	getDirectory()	Gets the directory associated with this session.
Id	getDirectoryId()	Gets the Id of this directory.
DataInputStream	getInputStream(String name)	Gets the input stream for reading a file.
DataOutputStream	getOutputStream(String name)	Gets an output stream for writing to this file, replacing any existing contents.
DataOutputStream	getOutputStreamForAppend(String name)	Gets an output stream for appending to this file.
void	touch(String name)	Updates the modified time of a file to be the current time.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getDirectoryId

Id getDirectoryId()

Gets the Id of this directory.

Returns:

the Id of this directory

Compliance:

mandatory - This method must be implemented.

getDirectory

Directory getDirectory()
                throws OperationFailedException,
PermissionDeniedException

Gets the directory associated with this session.

Returns:

the directory associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canReadFiles

boolean canReadFiles()

Tests if this user can access files in this directory. A return of true does not guarantee successful authorization. A return of false indicates that it is known accessing this file will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer read operations to unauthorized users.

Returns:

false if file access is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getInputStream

DataInputStream getInputStream(String name)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the input stream for reading a file. The input stream reads until the end of the file.

Parameters:

name - the relative or absolute path name

Returns:

the input stream for reading this file

Throws:

NotFoundException - name is not found

NullArgumentException - name is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBlockingInputStream

DataInputStream getBlockingInputStream(String name)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the input stream for reading this file. The returned input stream, once it reaches the end of the file, blocks for new content that may be later appended to the file.

Parameters:

name - the relative or absolute path name

Returns:

the input stream for reading this file

Throws:

NotFoundException - name is not found

NullArgumentException - name is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canWriteFiles

boolean canWriteFiles()

Tests if this user can update this file. A return of true does not guarantee successful authorization. A return of false indicates that it is known writing to this this file will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer write operations to unauthorized users.

Returns:

false if file writing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getOutputStream

DataOutputStream getOutputStream(String name)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets an output stream for writing to this file, replacing any existing contents.

Parameters:

name - the relative or absolute path name

Returns:

the output stream for writing to this file

Throws:

NotFoundException - name is not found

NullArgumentException - name is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOutputStreamForAppend

DataOutputStream getOutputStreamForAppend(String name)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets an output stream for appending to this file.

Parameters:

name - the relative or absolute path name

Returns:

the output stream for appending to this file

Throws:

NotFoundException - name is not found

NullArgumentException - name is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

touch

void touch(String name)
    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Updates the modified time of a file to be the current time.

Parameters:

name - the relative or absolute path name

Throws:

NotFoundException - name is not found

NullArgumentException - name is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.