Apache Mina SSHD 2.15.0 · org.apache.sshd.common.util.io.ModifiableFileWatcher

Modifier and Type	Field and Description
private final Path	file
private final AtomicReference<FileSnapshot>	metadata
protected final LinkOption[]	options
public static final Set<PosixFilePermission>	STRICTLY_PROHIBITED_FILE_PERMISSION The `Set` of `PosixFilePermission` not allowed if strict permissions are enforced on key files

Access	Constructor and Description
public	ModifiableFileWatcher(Path file)
public	ModifiableFileWatcher(Path file, LinkOption... options)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the watched file has probably been changed checkReloadRequired()
public final boolean	exists()
public final Path	Returns: The watched `Path` getPath()
public final FileTime	lastModified()
public void	resetReloadAttributes() Resets the state attributes used to detect changes to the initial construction values - i.e., file assumed not to exist and no known size of modify time
public final long	size()
public PathResource	toPathResource()
public PathResource	toPathResource(OpenOption... options)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	updateReloadAttributes() May be called to refresh the state attributes used to detect changes e.g., file existence, size and last-modified time once re-loading is successfully completed.
public static AbstractMap.SimpleImmutableEntry<String, Object>	Returns: The violated permission as `SimpleImmutableEntry` where key is a loggable message and value is the offending object - e.g., `PosixFilePermission` or `String` for owner. Return value is `null` if no violations detected validateStrictConfigFilePermissions(Path The `Path` to be checked - ignored if `null` or does not exist path, LinkOption... The `LinkOption`s to use to query the file's permissions options) Checks if a path has strict permissions (For `Unix`) The path may not have group or others write permissions The path must be owned by current user. (For `Unix`) The path may be owned by root.

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: debug debug debug debug debug error error error error error getSimplifiedLogger info info warn warn warn warn warn warn warn warn

file	back to summary
private final Path file

options	back to summary
protected final LinkOption[] options

STRICTLY_PROHIBITED_FILE_PERMISSION	back to summary
public static final Set<PosixFilePermission> STRICTLY_PROHIBITED_FILE_PERMISSION The `Set` of `PosixFilePermission` not allowed if strict permissions are enforced on key files

ModifiableFileWatcher	back to summary
public ModifiableFileWatcher(Path file)

ModifiableFileWatcher	back to summary
public ModifiableFileWatcher(Path file, LinkOption... options)

Method Detail

checkReloadRequired	back to summary
public boolean checkReloadRequired() throws IOException Returns:boolean `true` if the watched file has probably been changed Exceptions IOException: If failed to query file data

exists	back to summary
public final boolean exists() throws IOException

getPath	back to summary
public final Path getPath() Returns:Path The watched `Path`

lastModified	back to summary
public final FileTime lastModified() throws IOException

resetReloadAttributes	back to summary
public void resetReloadAttributes() Resets the state attributes used to detect changes to the initial construction values - i.e., file assumed not to exist and no known size of modify time

size	back to summary
public final long size() throws IOException

toPathResource	back to summary
public PathResource toPathResource()

toPathResource	back to summary
public PathResource toPathResource(OpenOption... options)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

updateReloadAttributes back to summary

updateReloadAttributes	back to summary
public void updateReloadAttributes() throws IOException May be called to refresh the state attributes used to detect changes e.g., file existence, size and last-modified time once re-loading is successfully completed. If the file does not exist then the attributes are reset to an "unknown" state. Exceptions IOException: If failed to access the file (if exists) See Also `resetReloadAttributes()`

public void updateReloadAttributes() throws IOException

May be called to refresh the state attributes used to detect changes e.g., file existence, size and last-modified time once re-loading is successfully completed. If the file does not exist then the attributes are reset to an "unknown" state.

Exceptions

IOException:: If failed to access the file (if exists)

See Also

resetReloadAttributes()

validateStrictConfigFilePermissions back to summary

validateStrictConfigFilePermissions	back to summary
public static AbstractMap.SimpleImmutableEntry<String, Object> validateStrictConfigFilePermissions(Path path, LinkOption... options) throws IOException Checks if a path has strict permissions (For `Unix`) The path may not have group or others write permissions The path must be owned by current user. (For `Unix`) The path may be owned by root. Parameters path:Path The `Path` to be checked - ignored if `null` or does not exist options:LinkOption[] The `LinkOption`s to use to query the file's permissions Returns:AbstractMap.SimpleImmutableEntry<String, Object> The violated permission as `SimpleImmutableEntry` where key is a loggable message and value is the offending object - e.g., `PosixFilePermission` or `String` for owner. Return value is `null` if no violations detected Exceptions IOException: If failed to retrieve the permissions See Also `STRICTLY_PROHIBITED_FILE_PERMISSION`

public static AbstractMap.SimpleImmutableEntry<String, Object> validateStrictConfigFilePermissions(Path path, LinkOption... options) throws IOException

Checks if a path has strict permissions

(For Unix) The path may not have group or others write permissions
The path must be owned by current user.
(For Unix) The path may be owned by root.

Parameters

path:Path: The Path to be checked - ignored if null or does not exist
options:LinkOption[]: The LinkOptions to use to query the file's permissions

Returns:AbstractMap.SimpleImmutableEntry<String, Object>

The violated permission as SimpleImmutableEntry where key is a loggable message and value is the offending object - e.g., PosixFilePermission or String for owner. Return value is null if no violations detected

Exceptions

IOException:: If failed to retrieve the permissions

See Also

STRICTLY_PROHIBITED_FILE_PERMISSION

public Class ModifiableFileWatcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail