org.kitteh.irc.client.library.feature.sts

Class StsPropertiesStorageManager

java.lang.Object

org.kitteh.irc.client.library.feature.sts.StsPropertiesStorageManager

All Implemented Interfaces:

StsStorageManager

public class StsPropertiesStorageManager
extends Object
implements StsStorageManager

Simple example implementation of an STSStorageManager.

Constructor Summary

Constructors

Constructor and Description
StsPropertiesStorageManager(Path filePath) Simple implementation of STSStorageManager which uses a properties file.

Method Summary

Modifier and Type	Method and Description
void	addEntry(String hostname, long duration, StsPolicy policy) Adds an entry to the store, storing data in the backing properties file.
Optional<StsPolicy>	getEntry(String hostname) Gets an STS policy from the store, looking it up via hostname.
boolean	hasEntry(String hostname) Checks if a policy has been stored for the hostname.
void	removeEntry(String hostname) Deletes an entry from the store (used for 0 duration policies).

Methods inherited from class java.lang.Object

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

Constructor Detail

StsPropertiesStorageManager

public StsPropertiesStorageManager(@Nonnull
                                   Path filePath)

Simple implementation of STSStorageManager which uses a properties file.

Parameters:

filePath - the path to the properties file used to persist the data

Method Detail

addEntry

public void addEntry(@Nonnull
                     String hostname,
                     long duration,
                     @Nonnull
                     StsPolicy policy)

Adds an entry to the store, storing data in the backing properties file.

Specified by:

addEntry in interface StsStorageManager

Parameters:

hostname - the hostname (as sent in the SNI by the client)

duration - the length (in seconds) until the expiry of this stored policy

policy - the STS policy instance, including all data sent from the server

getEntry

@Nonnull
public Optional<StsPolicy> getEntry(@Nonnull
                                              String hostname)

Gets an STS policy from the store, looking it up via hostname.

Specified by:

getEntry in interface StsStorageManager

Parameters:

hostname - the hostname (as sent in the SNI by the client)

Returns:

all data sent by the server in the CAP LS "sts" value when we connected securely

hasEntry

public boolean hasEntry(@Nonnull
                        String hostname)

Checks if a policy has been stored for the hostname.

Specified by:

hasEntry in interface StsStorageManager

Parameters:

hostname - the hostname to check

Returns:

whether the entry exists in the store

removeEntry

public void removeEntry(@Nonnull
                        String hostname)

Deletes an entry from the store (used for 0 duration policies).

Implementers MUST ignore requests to remove entries that do not exist.

Specified by:

removeEntry in interface StsStorageManager

Parameters:

hostname - the hostname to remove the policy for