org.gridgain.grid.persistentstore

Class SnapshotLocation

java.lang.Object

org.gridgain.grid.persistentstore.SnapshotLocation

public final class SnapshotLocation
extends Object

Location a snapshot is read from or written to.

A location is either a local path or a URI. A URI can carry a password, so toString() masks it.

Printing a location is therefore safe by default. raw() marks the places that need the password itself.

Constructor Summary

Constructors

Constructor and Description
SnapshotLocation(String location)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
boolean	isSftp()
static @Nullable SnapshotLocation	of(@Nullable String location)
static @Nullable List<SnapshotLocation>	ofAll(@Nullable Collection<String> locations)
String	raw() Returns the location including any password it carries.
static @Nullable List<String>	rawAll(@Nullable Collection<SnapshotLocation> locations)
static @Nullable String	rawOf(@Nullable SnapshotLocation location)
Path	toPath()
String	toString()
URI	toUri()

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotLocation

public SnapshotLocation(String location)

Parameters:

location - Location as it was configured. Must not be null.

Method Detail

of

@Nullable
public static @Nullable SnapshotLocation of(@Nullable
                                                      @Nullable String location)

Parameters:

location - Location as it was configured, possibly null.

Returns:

Location, or null if location is null.

raw

public String raw()

Returns the location including any password it carries.

Only code that opens the repository needs this. Anything that shows a location to a human must use toString() instead.

Returns:

Location as it was configured.

ofAll

@Nullable
public static @Nullable List<SnapshotLocation> ofAll(@Nullable
                                                               @Nullable Collection<String> locations)

Parameters:

locations - Locations as they were configured, possibly null.

Returns:

Locations, or null if locations is null.

rawOf

@Nullable
public static @Nullable String rawOf(@Nullable
                                               @Nullable SnapshotLocation location)

Parameters:

location - Location, possibly null.

Returns:

Value of raw(), or null if location is null.

rawAll

@Nullable
public static @Nullable List<String> rawAll(@Nullable
                                                      @Nullable Collection<SnapshotLocation> locations)

Parameters:

locations - Locations, possibly null.

Returns:

Values of raw(), or null if locations is null.

isSftp

public boolean isSftp()

Returns:

True if this is an SFTP location.

toUri

public URI toUri()
          throws URISyntaxException

Returns:

This location as a URI.

Throws:

URISyntaxException - If the location is not a valid URI.

toPath

public Path toPath()

Returns:

This location as a local file system path.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object