org.opensaml.util.resource

クラス FileBackedHttpResource

java.lang.Object

org.opensaml.util.resource.AbstractFilteredResource

org.opensaml.util.resource.HttpResource

org.opensaml.util.resource.FileBackedHttpResource

すべての実装されたインタフェース:

Resource

public class FileBackedHttpResource
extends HttpResource

A resource representing a file read from an HTTP(S) location. Every time the file is successfully read from the URL location it is written to a backing file. If the file can not be read from the URL it is read from this backing file, if available. Note, large files should not be accessed in this manner as the entire file is read into memory before being written to disk and then returned.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
FileBackedHttpResource(String resource, String backingFile) Constructor.
FileBackedHttpResource(String resource, String backingFile, ResourceFilter resourceFilter) 推奨されていません。 use AbstractFilteredResource.setResourceFilter(ResourceFilter) instead
FileBackedHttpResource(String resource, URI backingFile) Constructor.
FileBackedHttpResource(String resource, URI backingFile, ResourceFilter resourceFilter) 推奨されていません。 use AbstractFilteredResource.setResourceFilter(ResourceFilter) instead

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
boolean	exists() Checks whether the resource exists.
InputStream	getInputStream() Gets the inputstream to the resource's data.
org.joda.time.DateTime	getLastModifiedTime() Gets the date and time the resource was last modified.
String	getLocation() Gets resource location information.
protected void	saveToResourceFile(byte[] resource) Saves a resource to the backing file.

クラスから継承されたメソッド org.opensaml.util.resource.HttpResource

equals, getResource, hashCode, toString

クラスから継承されたメソッド org.opensaml.util.resource.AbstractFilteredResource

applyFilter, getResourceFilter, setResourceFilter

クラスから継承されたメソッド java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

FileBackedHttpResource

public FileBackedHttpResource(String resource,
                      String backingFile)

Constructor.

パラメータ:

resource - HTTP(S) URL of the resource

backingFile - filesystem location to store the resource

FileBackedHttpResource

public FileBackedHttpResource(String resource,
                      URI backingFile)

Constructor.

パラメータ:

resource - HTTP(S) URL of the resource

backingFile - file: URI location to store the resource

導入されたバージョン:

1.2

FileBackedHttpResource

public FileBackedHttpResource(String resource,
                      String backingFile,
                      ResourceFilter resourceFilter)

推奨されていません。 use AbstractFilteredResource.setResourceFilter(ResourceFilter) instead

Constructor.

パラメータ:

resource - HTTP(S) URL of the resource

backingFile - filesystem location to store the resource

resourceFilter - filter to apply to this resource

FileBackedHttpResource

public FileBackedHttpResource(String resource,
                      URI backingFile,
                      ResourceFilter resourceFilter)

推奨されていません。 use AbstractFilteredResource.setResourceFilter(ResourceFilter) instead

Constructor.

パラメータ:

resource - HTTP(S) URL of the resource

backingFile - filesystem location to store the resource

resourceFilter - filter to apply to this resource

導入されたバージョン:

1.2

メソッドの詳細

exists

public boolean exists()
               throws ResourceException

Checks whether the resource exists.

定義:

exists インタフェース内 Resource

オーバーライド:

exists クラス内 HttpResource

戻り値:

true if the resource exists, false if not

例外:

ResourceException - thrown if there is a problem determining if the resource exists

getInputStream

public InputStream getInputStream()
                           throws ResourceException

Gets the inputstream to the resource's data.

定義:

getInputStream インタフェース内 Resource

オーバーライド:

getInputStream クラス内 HttpResource

戻り値:

inputstream to the resource's data

例外:

ResourceException - thrown if an input stream can not be created for the resource

getLastModifiedTime

public org.joda.time.DateTime getLastModifiedTime()
                                           throws ResourceException

Gets the date and time the resource was last modified.

定義:

getLastModifiedTime インタフェース内 Resource

オーバーライド:

getLastModifiedTime クラス内 HttpResource

戻り値:

date and time the resource was last modified

例外:

ResourceException - thrown if the last modified time can not be determined

getLocation

public String getLocation()

Gets resource location information. Examples might be filesystem path, URL, etc.

定義:

getLocation インタフェース内 Resource

オーバーライド:

getLocation クラス内 HttpResource

戻り値:

resource location information

saveToResourceFile

protected void saveToResourceFile(byte[] resource)
                           throws ResourceException

Saves a resource to the backing file.

パラメータ:

resource - the string representation of the resource

例外:

ResourceException - thrown if the resource backing file can not be written to