DefaultFileLoadingStrategy (Shibboleth IdP :: Plugins :: OIDC Common :: Relying Party Metadata Implementation 2.1.0 API)

java.lang.Object
- net.shibboleth.oidc.metadata.cache.impl.DefaultFileLoadingStrategy

All Implemented Interfaces:: LoadingStrategy

@ThreadSafe
public class DefaultFileLoadingStrategy
extends Object
implements LoadingStrategy

Default strategy for loading information from a file.

Field Summary

Fields
Modifier and Type	Field	Description
`private org.slf4j.Logger`	`log`	Class logger.
`private File`	`metadataFile`	The metadata file.
`private String`	`metadataFileFriendlyName`	The metadata file name to use in logs.

Constructor Summary

Constructors
Constructor Description

DefaultFileLoadingStrategy(Resource metadata)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private Instant`	`getMetadataUpdateTime()`	Get the time for the last update/modification of the metadata file.
`String`	`getSourceIdentifier()`
`byte[]`	`load(CacheLoadingContext context)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

metadataFile

@Nullable
private final File metadataFile

The metadata file.

metadataFileFriendlyName

@Nonnull
@NotEmpty
private final String metadataFileFriendlyName

The metadata file name to use in logs.

Constructor Detail

DefaultFileLoadingStrategy

public DefaultFileLoadingStrategy(@Nullable
                                  Resource metadata)
                           throws IOException

Constructor.

Parameters:: metadata - the metadata file resource. Can be null.
Throws:: IOException - if the file is not null put does not exist.

Method Detail
- getMetadataUpdateTime
```
private Instant getMetadataUpdateTime()
```
  Get the time for the last update/modification of the metadata file.
  
  Returns:
  
  The last update time.
- load
```
@Nullable
public byte[] load(@Nonnull
                   CacheLoadingContext context)
            throws CacheLoadingException
```
  Specified by:
  
  load in interface LoadingStrategy
  
  Throws:
  
  CacheLoadingException
- getSourceIdentifier
```
@Nonnull
public String getSourceIdentifier()
```
  Specified by:
  
  getSourceIdentifier in interface LoadingStrategy