org.alfresco.jlan.client.admin

Class WinregPipeFile

java.lang.Object

org.alfresco.jlan.client.admin.IPCPipeFile

org.alfresco.jlan.client.admin.WinregPipeFile

public class WinregPipeFile
extends IPCPipeFile

Windows Registry Pipe File Class

Pipe file connected to a remote Windows registry DCE/RPC service that can be used to retrieve, update and create values and keys in the remote registry.

Constructor Summary

Constructors

Constructor and Description
WinregPipeFile(IPCSession sess, DCEPacket pkt, int handle, java.lang.String name, int maxTx, int maxRx) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	closeHandle(RegistryKey handle) Close a hive or key.
RegistryKey	createKey(RegistryKey parent, java.lang.String keyName) Create a new key
void	createValue(RegistryKey parent, RegistryValue value) Create a new registry value
void	deleteKey(RegistryKey parent, java.lang.String keyName) Delete a registry key
void	deleteValue(RegistryKey parent, java.lang.String valueName) Delete a registry value
RegistryValue	getDefaultValue(RegistryKey key) Return the default value for the specified key
RegistryKeyInfo	getKeyInfo(RegistryKey handle, java.lang.String cls) Return information about a registry key.
java.util.List	getKeysForKey(RegistryKey parentKey) Return the sub-keys for the specified registry key
RegistryValue	getValue(RegistryKey key, RegistryValue regval) Return the value for the specified key and parameter
RegistryValue	getValue(RegistryKey key, java.lang.String name) Return the value for the specified key and parameter
java.util.List	getValuesForKey(RegistryKey key) Return the values for the specified registry key
RegistryKey	openHKClassesRoot() Open the HKEY_CLASSES_ROOT registry key on the remote server.
RegistryKey	openHKCurrentUser() Open the HKEY_CURRENT_USER registry key on the remote server.
RegistryKey	openHKLocalMachine() Open the HIVE_KEY_LOCAL_MACHINE (HKLM) registry key on the remote server.
RegistryKey	openHKPerformanceData() Open the HKEY_PERFORMANCE_DATA registry key on the remote server.
RegistryKey	openHKUsers() Open the HIVE_KEY_USERS (HKU) registry key on the remote server.
RegistryKey	openKey(RegistryKey root, RegistryKey key) Open a registry key.
RegistryKey	openKey(RegistryKey root, java.lang.String key) Open a registry key.
RegistryKey	openRootKey(int keyid) Open a root key on the remote server
void	shutdownServer(java.lang.String msg, int tmo, boolean reboot, boolean force) Shutdown a remote system, and optionally reboot the system

Methods inherited from class org.alfresco.jlan.client.admin.IPCPipeFile

checkStatus, ClosePipe, doDCERequest, doDCERequest, getBuffer, getCallId, getHandle, getMaximumReceiveSize, getMaximumTransmitSize, getNextCallId, getPacket, getPipeName, getRxBuffer, getSession, isClosed, setMaximumReceiveSize, setMaximumTransmitSize, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WinregPipeFile

public WinregPipeFile(IPCSession sess,
              DCEPacket pkt,
              int handle,
              java.lang.String name,
              int maxTx,
              int maxRx)

Class constructor

Parameters:

sess - SMBIPCSession

pkt - DCEPacket

handle - int

name - String

maxTx - int

maxRx - int

Method Detail

openHKLocalMachine

public final RegistryKey openHKLocalMachine()
                                     throws java.io.IOException,
                                            SMBException

Open the HIVE_KEY_LOCAL_MACHINE (HKLM) registry key on the remote server. The returned policy handle is used to access the keys/values.

Returns:

RegistryKey

Throws:

java.io.IOException

SMBException

openHKUsers

public final RegistryKey openHKUsers()
                              throws java.io.IOException,
                                     SMBException

Open the HIVE_KEY_USERS (HKU) registry key on the remote server. The returned policy handle is used to access the keys/values.

Returns:

RegistryKey

Throws:

java.io.IOException

SMBException

openHKClassesRoot

public final RegistryKey openHKClassesRoot()
                                    throws java.io.IOException,
                                           SMBException

Open the HKEY_CLASSES_ROOT registry key on the remote server. The returned policy handle is used to access the keys/values.

Returns:

RegistryKey

Throws:

java.io.IOException

SMBException

openHKCurrentUser

public final RegistryKey openHKCurrentUser()
                                    throws java.io.IOException,
                                           SMBException

Open the HKEY_CURRENT_USER registry key on the remote server. The returned policy handle is used to access the keys/values.

Returns:

RegistryKey

Throws:

java.io.IOException

SMBException

openHKPerformanceData

public final RegistryKey openHKPerformanceData()
                                        throws java.io.IOException,
                                               SMBException

Open the HKEY_PERFORMANCE_DATA registry key on the remote server. The returned policy handle is used to access the keys/values.

Returns:

RegistryKey

Throws:

java.io.IOException

SMBException

openKey

public final RegistryKey openKey(RegistryKey root,
                  java.lang.String key)
                          throws java.io.IOException,
                                 SMBException

Open a registry key.

Parameters:

handle - RegistryKey

key - String

Returns:

RegistryKey

Throws:

java.io.IOException

SMBException

openKey

public final RegistryKey openKey(RegistryKey root,
                  RegistryKey key)
                          throws java.io.IOException,
                                 SMBException

Open a registry key.

Parameters:

handle - RegistryKey

key - RegistryKey

Returns:

RegistryKey

Throws:

java.io.IOException

SMBException

closeHandle

public final void closeHandle(RegistryKey handle)
                       throws java.io.IOException,
                              SMBException

Close a hive or key.

Parameters:

handle - RegistryKey

Throws:

java.io.IOException

SMBException

getKeyInfo

public final RegistryKeyInfo getKeyInfo(RegistryKey handle,
                         java.lang.String cls)
                                 throws java.io.IOException,
                                        SMBException

Return information about a registry key.

Parameters:

handle - RegistryKey

cls - String

Returns:

RegistryKeyInfo

Throws:

java.io.IOException

SMBException

getValue

public final RegistryValue getValue(RegistryKey key,
                     java.lang.String name)
                             throws java.io.IOException,
                                    SMBException

Return the value for the specified key and parameter

Parameters:

handle - RegistryKey

name - String

Returns:

RegistryValue

Throws:

java.io.IOException

SMBException

getValue

public final RegistryValue getValue(RegistryKey key,
                     RegistryValue regval)
                             throws java.io.IOException,
                                    SMBException

Return the value for the specified key and parameter

Parameters:

handle - RegistryKey

regval - RegistryValue

Returns:

RegistryValue

Throws:

java.io.IOException

SMBException

getDefaultValue

public final RegistryValue getDefaultValue(RegistryKey key)
                                    throws java.io.IOException,
                                           SMBException

Return the default value for the specified key

Parameters:

handle - RegistryKey

Returns:

RegistryValue

Throws:

java.io.IOException

SMBException

getValuesForKey

public final java.util.List getValuesForKey(RegistryKey key)
                                     throws java.io.IOException,
                                            SMBException

Return the values for the specified registry key

Parameters:

key - RegistryKey

Returns:

List

Throws:

java.io.IOException

SMBException

getKeysForKey

public final java.util.List getKeysForKey(RegistryKey parentKey)
                                   throws java.io.IOException,
                                          SMBException

Return the sub-keys for the specified registry key

Parameters:

key - RegistryKey

Returns:

List

Throws:

java.io.IOException

SMBException

createKey

public final RegistryKey createKey(RegistryKey parent,
                    java.lang.String keyName)
                            throws java.io.IOException,
                                   SMBException

Create a new key

Parameters:

parent - RegistryKey

keyName - String

Throws:

java.io.IOException

SMBException

deleteKey

public final void deleteKey(RegistryKey parent,
             java.lang.String keyName)
                     throws java.io.IOException,
                            SMBException

Delete a registry key

Parameters:

parent - RegistryKey

keyName - String

Throws:

java.io.IOException

SMBException

createValue

public final void createValue(RegistryKey parent,
               RegistryValue value)
                       throws java.io.IOException,
                              SMBException

Create a new registry value

Parameters:

parent - RegistryKey

value - RegistryValue

Throws:

java.io.IOException

SMBException

deleteValue

public final void deleteValue(RegistryKey parent,
               java.lang.String valueName)
                       throws java.io.IOException,
                              SMBException

Delete a registry value

Parameters:

parent - RegistryKey

valueName - String

Throws:

java.io.IOException

SMBException

shutdownServer

public final void shutdownServer(java.lang.String msg,
                  int tmo,
                  boolean reboot,
                  boolean force)
                          throws java.io.IOException,
                                 SMBException

Shutdown a remote system, and optionally reboot the system

Parameters:

msg - String

tmo - int

reboot - boolean

force - boolean

Throws:

java.io.IOException

SMBException

openRootKey

public final RegistryKey openRootKey(int keyid)
                              throws java.io.IOException,
                                     SMBException

Open a root key on the remote server

Parameters:

keyid - int

Returns:

RegistryKey

Throws:

java.io.IOException

SMBException