org.opensaml.saml2.metadata.provider

クラス HTTPMetadataProvider

java.lang.Object

org.opensaml.saml2.metadata.provider.BaseMetadataProvider

org.opensaml.saml2.metadata.provider.AbstractMetadataProvider

org.opensaml.saml2.metadata.provider.AbstractObservableMetadataProvider

org.opensaml.saml2.metadata.provider.AbstractReloadingMetadataProvider

org.opensaml.saml2.metadata.provider.HTTPMetadataProvider

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

MetadataProvider, ObservableMetadataProvider

直系の既知のサブクラス:

FileBackedHTTPMetadataProvider

public class HTTPMetadataProvider
extends AbstractReloadingMetadataProvider

A metadata provider that pulls metadata using an HTTP GET. Metadata is cached until one of these criteria is met:

• The smallest cacheDuration within the metadata is exceeded
• The earliest validUntil time within the metadata is exceeded
• The maximum cache duration is exceeded

Metadata is filtered prior to determining the cache expiration data. This allows a filter to remove XMLObjects that may effect the cache duration but for which the user of this provider does not care about. It is the responsibility of the caller to re-initialize, via AbstractMetadataProvider.initialize(), if any properties of this provider are changed.

ネストされたクラスの概要

インタフェースから継承されたネストされたクラス/インタフェース org.opensaml.saml2.metadata.provider.ObservableMetadataProvider

ObservableMetadataProvider.Observer

フィールドの概要

クラスから継承されたフィールド org.opensaml.saml2.metadata.provider.BaseMetadataProvider

unmarshallerFactory

コンストラクタの概要

コンストラクタ

コンストラクタと説明
HTTPMetadataProvider(String metadataURL, int requestTimeout) 推奨されていません。
HTTPMetadataProvider(Timer backgroundTaskTimer, org.apache.commons.httpclient.HttpClient client, String metadataURL) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected org.apache.commons.httpclient.methods.GetMethod	buildGetMethod() Builds the HTTP GET method used to fetch the metadata.
void	destroy() Destroys the metadata provider and frees any resources current held by it.
protected byte[]	fetchMetadata() Gets the metadata document from the remote server.
int	getMaxCacheDuration() 推奨されていません。 use AbstractReloadingMetadataProvider.getMaxRefreshDelay() instead
protected byte[]	getMetadataBytesFromResponse(org.apache.commons.httpclient.methods.GetMethod getMethod) Extracts the raw metadata bytes from the response taking in to account possible deflate and GZip compression.
protected String	getMetadataIdentifier() Gets an identifier which may be used to distinguish this metadata in logging statements.
String	getMetadataURI() Gets the URL to fetch the metadata.
int	getRequestTimeout() Gets the length of time in milliseconds to wait for the server to respond.
boolean	maintainExpiredMetadata() 推奨されていません。 use BaseMetadataProvider.requireValidMetadata() instead
protected void	processConditionalRetrievalHeaders(org.apache.commons.httpclient.methods.GetMethod getMethod) Records the ETag and Last-Modified headers, from the response, if they are present.
void	setBasicCredentials(String username, String password) Sets the username and password used to access the metadata URL.
void	setMaintainExpiredMetadata(boolean maintain) 推奨されていません。 use BaseMetadataProvider.setRequireValidMetadata(boolean) instead
void	setMaxCacheDuration(int newDuration) 推奨されていません。 use AbstractReloadingMetadataProvider.setMaxRefreshDelay(long) instead
void	setSocketFactory(org.apache.commons.httpclient.protocol.ProtocolSocketFactory newSocketFactory) 推奨されていません。 set this information on HTTP client used by provider

クラスから継承されたメソッド org.opensaml.saml2.metadata.provider.AbstractReloadingMetadataProvider

computeNextRefreshDelay, doGetMetadata, doInitialization, getExpirationTime, getLastRefresh, getLastUpdate, getMaxRefreshDelay, getMinRefreshDelay, getNextRefresh, getRefreshDelayFactor, inputstreamToByteArray, postProcessMetadata, processCachedMetadata, processNewMetadata, processNonExpiredMetadata, processPreExpiredMetadata, refresh, setMaxRefreshDelay, setMinRefreshDelay, setRefreshDelayFactor, unmarshallMetadata

クラスから継承されたメソッド org.opensaml.saml2.metadata.provider.AbstractObservableMetadataProvider

emitChangeEvent, getObservers

クラスから継承されたメソッド org.opensaml.saml2.metadata.provider.AbstractMetadataProvider

clearDescriptorIndex, doGetEntitiesDescriptor, doGetEntityDescriptor, doGetRole, doGetRole, filterMetadata, getEntitiesDescriptor, getEntitiesDescriptorByName, getEntityDescriptor, getEntityDescriptorById, getEntityDescriptorById, getMetadata, getParserPool, getRole, getRole, initialize, isFailFastInitialization, isInitialized, isValid, releaseMetadataDOM, setFailFastInitialization, setInitialized, setParserPool, unmarshallMetadata

クラスから継承されたメソッド org.opensaml.saml2.metadata.provider.BaseMetadataProvider

getMetadataFilter, requireValidMetadata, setMetadataFilter, setRequireValidMetadata

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

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

インタフェースから継承されたメソッド org.opensaml.saml2.metadata.provider.MetadataProvider

getEntitiesDescriptor, getEntityDescriptor, getMetadata, getMetadataFilter, getRole, getRole, requireValidMetadata, setMetadataFilter, setRequireValidMetadata

コンストラクタの詳細

HTTPMetadataProvider

@Deprecated
public HTTPMetadataProvider(String metadataURL,
                               int requestTimeout)
                     throws MetadataProviderException

推奨されていません。

Constructor.

パラメータ:

metadataURL - the URL to fetch the metadata

requestTimeout - the time, in milliseconds, to wait for the metadata server to respond

例外:

MetadataProviderException - thrown if the URL is not a valid URL or the metadata can not be retrieved from the URL

HTTPMetadataProvider

public HTTPMetadataProvider(Timer backgroundTaskTimer,
                    org.apache.commons.httpclient.HttpClient client,
                    String metadataURL)
                     throws MetadataProviderException

Constructor.

パラメータ:

client - HTTP client used to pull in remote metadata

backgroundTaskTimer - timer used to schedule background metadata refresh tasks

metadataURL - URL to the remove remote metadata

例外:

MetadataProviderException - thrown if the HTTP client is null or the metadata URL provided is invalid

メソッドの詳細

getMetadataURI

public String getMetadataURI()

Gets the URL to fetch the metadata.

戻り値:

the URL to fetch the metadata

setBasicCredentials

public void setBasicCredentials(String username,
                       String password)

Sets the username and password used to access the metadata URL. To disable BASIC authentication set the username and password to null;

パラメータ:

username - the username

password - the password

getRequestTimeout

public int getRequestTimeout()

Gets the length of time in milliseconds to wait for the server to respond.

戻り値:

length of time in milliseconds to wait for the server to respond

setSocketFactory

public void setSocketFactory(org.apache.commons.httpclient.protocol.ProtocolSocketFactory newSocketFactory)

推奨されていません。 set this information on HTTP client used by provider

Sets the socket factory used to create sockets to the HTTP server.

パラメータ:

newSocketFactory - the socket factory used to produce sockets used to connect to the server

関連項目:

HTTPClient SSL guide

getMaxCacheDuration

public int getMaxCacheDuration()

推奨されていません。 use AbstractReloadingMetadataProvider.getMaxRefreshDelay() instead

Gets the maximum amount of time, in seconds, metadata will be cached for.

戻り値:

maximum amount of time, in seconds, metadata will be cached for

setMaxCacheDuration

public void setMaxCacheDuration(int newDuration)

推奨されていません。 use AbstractReloadingMetadataProvider.setMaxRefreshDelay(long) instead

Sets the maximum amount of time, in seconds, metadata will be cached for.

パラメータ:

newDuration - maximum amount of time, in seconds, metadata will be cached for

maintainExpiredMetadata

public boolean maintainExpiredMetadata()

推奨されていません。 use BaseMetadataProvider.requireValidMetadata() instead

Gets whether cached metadata should be discarded if it expires and can not be refreshed.

戻り値:

whether cached metadata should be discarded if it expires and can not be refreshed.

setMaintainExpiredMetadata

public void setMaintainExpiredMetadata(boolean maintain)

推奨されていません。 use BaseMetadataProvider.setRequireValidMetadata(boolean) instead

Sets whether cached metadata should be discarded if it expires and can not be refreshed.

パラメータ:

maintain - whether cached metadata should be discarded if it expires and can not be refreshed.

destroy

public void destroy()

Destroys the metadata provider and frees any resources current held by it. Default method is a no-op.

オーバーライド:

destroy クラス内 AbstractReloadingMetadataProvider

getMetadataIdentifier

protected String getMetadataIdentifier()

Gets an identifier which may be used to distinguish this metadata in logging statements.

定義:

getMetadataIdentifier クラス内 AbstractReloadingMetadataProvider

戻り値:

identifier which may be used to distinguish this metadata in logging statements

fetchMetadata

protected byte[] fetchMetadata()
                        throws MetadataProviderException

Gets the metadata document from the remote server.

定義:

fetchMetadata クラス内 AbstractReloadingMetadataProvider

戻り値:

the metadata from remote server, or null if the metadata document has not changed since the last retrieval

例外:

MetadataProviderException - thrown if there is a problem retrieving the metadata from the remote server

buildGetMethod

protected org.apache.commons.httpclient.methods.GetMethod buildGetMethod()

Builds the HTTP GET method used to fetch the metadata. The returned method advertises support for GZIP and deflate compression, enables conditional GETs if the cached metadata came with either an ETag or Last-Modified information, and sets up basic authentication if such is configured.

戻り値:

the constructed GET method

processConditionalRetrievalHeaders

protected void processConditionalRetrievalHeaders(org.apache.commons.httpclient.methods.GetMethod getMethod)

Records the ETag and Last-Modified headers, from the response, if they are present.

パラメータ:

getMethod - GetMethod containing a valid HTTP response

getMetadataBytesFromResponse

protected byte[] getMetadataBytesFromResponse(org.apache.commons.httpclient.methods.GetMethod getMethod)
                                       throws MetadataProviderException

Extracts the raw metadata bytes from the response taking in to account possible deflate and GZip compression.

パラメータ:

getMethod - GetMethod containing a valid HTTP response

戻り値:

the raw metadata bytes

例外:

MetadataProviderException - thrown if there is a problem getting the raw metadata bytes from the response