Apache Mina SSHD 2.15.0 · org.apache.sshd.agent.unix.AprLibrary

Modifier and Type	Field and Description
private static AprLibrary	library
private final long	pool

Access	Constructor and Description
private	AprLibrary() APR library singleton constructor.

Method Summary

Modifier and Type	Method and Description
private static void	chmodOwner(String authSocket, boolean execute)
pack-priv static String	createLocalSocketAddress()
protected void	finalize() Overrides java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
public static synchronized AprLibrary	Returns: the current APR library singleton getInstance() get the shared instance of APR library, if none, initialize one
pack-priv long	Returns: number identifying the root pool getRootPool() get the package wide root pool, the mother of all the pool created in APR transport module.
private static synchronized void	initialize() initialize the APR Library by loading the associated native libraries and creating the associated singleton
public static synchronized boolean	Returns: true if the Library is initialized, false otherwise isInitialized() is the APR library was initialized.
pack-priv static void	secureLocalSocket(String authSocket, long handle)

Inherited from java.lang.Object:: clone equals getClass hashCode notify notifyAll toString wait wait wait

library	back to summary
private static AprLibrary library

pool	back to summary
private final long pool

AprLibrary	back to summary
private AprLibrary() APR library singleton constructor. Called only when accessing the singleton the first time. It is initializing an APR memory pool for the whole package (a.k.a mother or root pool). Exceptions RuntimeException: if failed to load the library. Note: callers should inspect the cause of the exception in case an `Error` was thrown (e.g., `UnsatisfiedLinkError`).

Method Detail

chmodOwner	back to summary
private static void chmodOwner(String authSocket, boolean execute) throws IOException

createLocalSocketAddress	back to summary
pack-priv static String createLocalSocketAddress() throws IOException

finalize back to summary

finalize	back to summary
protected void finalize() throws Throwable Overrides java.lang.Object.finalize. Doc from java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the `finalize` method to dispose of system resources or to perform other cleanup. When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call `finalize()`. In a Java virtual machine in which finalization is enabled, the garbage collector might call `finalize` only after an indefinite delay. The general contract of `finalize` is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The `finalize` method may take any action, including making this object available again to other threads; the usual purpose of `finalize`, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded. The `finalize` method of class `Object` performs no special action; it simply returns normally. Subclasses of `Object` may override this definition. The Java programming language does not guarantee which thread will invoke the `finalize` method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates. After the `finalize` method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded. The `finalize` method is never invoked more than once by a Java virtual machine for any given object. Any exception thrown by the `finalize` method causes the finalization of this object to be halted, but is otherwise ignored. Annotations @Override @SuppressWarnings:checkstyle:NoFinalizer, deprecation Exceptions Throwable: the `Exception` raised by this method

protected void finalize() throws Throwable

Overrides java.lang.Object.finalize.

Doc from java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call finalize(). In a Java virtual machine in which finalization is enabled, the garbage collector might call finalize only after an indefinite delay.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Annotations

@Override
@SuppressWarnings:checkstyle:NoFinalizer, deprecation

Exceptions

Throwable:: the Exception raised by this method

getInstance	back to summary
public static synchronized AprLibrary getInstance() get the shared instance of APR library, if none, initialize one Returns:AprLibrary the current APR library singleton

getInstance

back to summary

public static synchronized AprLibrary getInstance()

get the shared instance of APR library, if none, initialize one

Returns:AprLibrary: the current APR library singleton

getRootPool	back to summary
pack-priv long getRootPool() get the package wide root pool, the mother of all the pool created in APR transport module. Returns:long number identifying the root pool

getRootPool

back to summary

pack-priv long getRootPool()

get the package wide root pool, the mother of all the pool created in APR transport module.

Returns:long: number identifying the root pool

initialize	back to summary
private static synchronized void initialize() initialize the APR Library by loading the associated native libraries and creating the associated singleton

isInitialized	back to summary
public static synchronized boolean isInitialized() is the APR library was initialized. Returns:boolean true if the Library is initialized, false otherwise

isInitialized

back to summary

public static synchronized boolean isInitialized()

is the APR library was initialized.

Returns:boolean: true if the Library is initialized, false otherwise

secureLocalSocket	back to summary
pack-priv static void secureLocalSocket(String authSocket, long handle) throws IOException

public final Class AprLibrary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail