org.apache.cocoon.components.source
Interface RestrictableSource

All Superinterfaces:

Source

public interface RestrictableSource
extends Source

A source, which is restrictable, which means you need a username and password.

Version:

CVS $Id: RestrictableSource.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Stephan Michels

Method Summary

void	addSourcePermission(SourcePermission sourcepermission) Add a permission to this source
SourceCredential	getSourceCredential() Get the current credential for the source
SourcePermission[]	getSourcePermissions() Returns a list of the existing permissions
void	removeSourcePermission(SourcePermission sourcepermission) Remove a permission from this source
void	setSourceCredential(SourceCredential sourcecredential) Set the credential for the source

Methods inherited from interface org.apache.excalibur.source.Source

exists, getContentLength, getInputStream, getLastModified, getMimeType, getScheme, getURI, getValidity, refresh

Method Detail

getSourceCredential

SourceCredential getSourceCredential()
                                     throws SourceException

Get the current credential for the source

Throws:

SourceException

setSourceCredential

void setSourceCredential(SourceCredential sourcecredential)
                         throws SourceException

Set the credential for the source

Throws:

SourceException

addSourcePermission

void addSourcePermission(SourcePermission sourcepermission)
                         throws SourceException

Add a permission to this source

Parameters:

sourcepermission - Permission, which should be set

Throws:

SourceException - If an exception occurs during this operation

removeSourcePermission

void removeSourcePermission(SourcePermission sourcepermission)
                            throws SourceException

Remove a permission from this source

Parameters:

sourcepermission - Permission, which should be removed

Throws:

SourceException - If an exception occurs during this operation

getSourcePermissions

SourcePermission[] getSourcePermissions()
                                        throws SourceException

Returns a list of the existing permissions

Returns:

Array of SourcePermission

Throws:

SourceException