org.alfresco.jlan.client.admin

Class SamrPipeFile

java.lang.Object

org.alfresco.jlan.client.admin.IPCPipeFile

org.alfresco.jlan.client.admin.SamrPipeFile

public class SamrPipeFile
extends IPCPipeFile

Security Accounts Manager Pipe File Class

Pipe file connected to a remote SAMR DCE/RPC service that can be used to retrieve information about remote users, groups, aliases, and perform id to name mappings.

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
static int	DefaultBufferSize

Constructor Summary

Constructors

Constructor and Description
SamrPipeFile(IPCSession sess, DCEPacket pkt, int handle, String name, int maxTx, int maxRx) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCaches() Clear the domain SID and policy handle caches.
void	closeHandle(PolicyHandle handle) Close the remote SAM service
void	ClosePipe() Close the pipe
StringList	enumerateAliases(String domain) Enumerate the aliases/local groups in a domain
StringList	enumerateDomains() Enumerate the domains in the server
StringList	enumerateGroups(String domain) Enumerate the groups in a domain
StringList	enumerateUsers(String domain) Enumerate the users in a domain
RIDList	getAliasesForUser(PolicyHandle domHandle, SID userSID) Return the list of aliases that the user has membership of
RIDList	getAliasesForUser(String domain, String userName) Return the list of aliases that the user has membership of
RIDList	getGroupsForUser(PolicyHandle usrHandle) Return the list of groups that the user has membership of
RIDList	getGroupsForUser(String domain, String userName) Return the list of groups that the user has membership of
SID	lookupDomain(String domain) Find a domain and return the SID
String	lookupDomainName(SID sid) Lookup the domain name for the specified security id
RIDList	lookupIds(PolicyHandle domHandle, int[] ids) Lookup resource ids within a domain and return the resource names and types
RIDList	lookupIds(PolicyHandle domHandle, int[] ids, int count) Lookup resource ids within a domain and return the resource names and types
RIDList	lookupIds(PolicyHandle domHandle, RIDList rids) Lookup resource ids within a domain and fill in the resource names and types.
RIDList	lookupName(PolicyHandle domHandle, String name) Lookup an object name within a domain and return the resource ids and types
RIDList	lookupName(SID sid) Lookup the object name for the specified security id
PolicyHandle	openBuiltinDomain() Open the built in domain
PolicyHandle	openDomain(SID domainSID) Open a domain and return the policy handle required to perform other functions on the domain
PolicyHandle	openDomain(String domain) Open a domain and return the policy handle required to perform other functions on the domain
protected SamrPolicyHandle	openService() Open the SAM service on the remote server
PolicyHandle	openUser(PolicyHandle domHandle, int rid) Open a user and return the policy handle required to perform other functions on the user
PolicyHandle	openUser(PolicyHandle domHandle, RID rid) Open a user and return the policy handle required to perform other functions on the user
PolicyHandle	openUser(String domain, String userName) Open a user and return the policy handle required to perform other functions on the user
UserInfo	queryUserInformation(PolicyHandle usrHandle, int infoLevel) Return information for the specified user

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

checkStatus, 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

Field Detail

DefaultBufferSize

public static final int DefaultBufferSize

See Also:

Constant Field Values

Constructor Detail

SamrPipeFile

public SamrPipeFile(IPCSession sess,
            DCEPacket pkt,
            int handle,
            String name,
            int maxTx,
            int maxRx)
             throws IOException,
                    SMBException,
                    DCEException

Class constructor

Parameters:

sess - SMBIPCSession

pkt - DCEPacket

handle - int

name - String

maxTx - int

maxRx - int

Throws:

IOException

SMBException

DCEException

Method Detail

openService

protected final SamrPolicyHandle openService()
                                      throws IOException,
                                             SMBException

Open the SAM service on the remote server

Returns:

SamrPolicyHandle

Throws:

IOException

SMBException

enumerateDomains

public final StringList enumerateDomains()
                                  throws IOException,
                                         SMBException

Enumerate the domains in the server

Returns:

StringList

Throws:

IOException

SMBException

enumerateGroups

public final StringList enumerateGroups(String domain)
                                 throws IOException,
                                        SMBException

Enumerate the groups in a domain

Returns:

StringList

Throws:

IOException

SMBException

enumerateUsers

public final StringList enumerateUsers(String domain)
                                throws IOException,
                                       SMBException

Enumerate the users in a domain

Returns:

StringList

Throws:

IOException

SMBException

enumerateAliases

public final StringList enumerateAliases(String domain)
                                  throws IOException,
                                         SMBException

Enumerate the aliases/local groups in a domain

Returns:

StringList

Throws:

IOException

SMBException

lookupDomain

public final SID lookupDomain(String domain)
                       throws IOException,
                              SMBException

Find a domain and return the SID

Parameters:

domain - String

Returns:

SID

Throws:

IOException

SMBException

openDomain

public final PolicyHandle openDomain(String domain)
                              throws IOException,
                                     SMBException

Open a domain and return the policy handle required to perform other functions on the domain

Parameters:

domain - String

Returns:

PolicyHandle

Throws:

IOException

SMBException

openBuiltinDomain

public final PolicyHandle openBuiltinDomain()
                                     throws IOException,
                                            SMBException

Open the built in domain

Returns:

PolicyHandle

Throws:

IOException

SMBException

openDomain

public final PolicyHandle openDomain(SID domainSID)
                              throws IOException,
                                     SMBException

Open a domain and return the policy handle required to perform other functions on the domain

Parameters:

domainSID - SID

Returns:

PolicyHandle

Throws:

IOException

SMBException

lookupName

public final RIDList lookupName(PolicyHandle domHandle,
                 String name)
                         throws IOException,
                                SMBException

Lookup an object name within a domain and return the resource ids and types

Parameters:

domHandle - PolicyHandle

name - String

Returns:

RIDList

Throws:

IOException

SMBException

lookupName

public final RIDList lookupName(SID sid)
                         throws IOException,
                                SMBException

Lookup the object name for the specified security id

Parameters:

sid - SID

Returns:

RIDList

Throws:

IOException

SMBException

lookupDomainName

public final String lookupDomainName(SID sid)
                              throws IOException,
                                     SMBException

Lookup the domain name for the specified security id

Parameters:

sid - SID

Returns:

String

Throws:

IOException

SMBException

lookupIds

public final RIDList lookupIds(PolicyHandle domHandle,
                RIDList rids)
                        throws IOException,
                               SMBException

Lookup resource ids within a domain and fill in the resource names and types. The original RIDList is returned with the names and types set.

Parameters:

domHandle - PolicyHandle

rids - RIDList

Returns:

RIDList

Throws:

IOException

SMBException

lookupIds

public final RIDList lookupIds(PolicyHandle domHandle,
                int[] ids)
                        throws IOException,
                               SMBException

Lookup resource ids within a domain and return the resource names and types

Parameters:

domHandle - PolicyHandle

ids - int[]

Returns:

RIDList

Throws:

IOException

SMBException

lookupIds

public final RIDList lookupIds(PolicyHandle domHandle,
                int[] ids,
                int count)
                        throws IOException,
                               SMBException

Lookup resource ids within a domain and return the resource names and types

Parameters:

domHandle - PolicyHandle

ids - int[]

count - int

Returns:

RIDList

Throws:

IOException

SMBException

openUser

public final PolicyHandle openUser(PolicyHandle domHandle,
                    RID rid)
                            throws IOException,
                                   SMBException

Open a user and return the policy handle required to perform other functions on the user

Parameters:

domHandle - domHandle PolicyHandle

rid - RID

Returns:

PolicyHandle

Throws:

IOException

SMBException

openUser

public final PolicyHandle openUser(String domain,
                    String userName)
                            throws IOException,
                                   SMBException

Open a user and return the policy handle required to perform other functions on the user

Parameters:

domain - String

userName - String

Returns:

PolicyHandle

Throws:

IOException

SMBException

openUser

public final PolicyHandle openUser(PolicyHandle domHandle,
                    int rid)
                            throws IOException,
                                   SMBException

Open a user and return the policy handle required to perform other functions on the user

Parameters:

domHandle - domHandle PolicyHandle

rid - int

Returns:

PolicyHandle

Throws:

IOException

SMBException

getGroupsForUser

public final RIDList getGroupsForUser(String domain,
                       String userName)
                               throws IOException,
                                      SMBException

Return the list of groups that the user has membership of

Parameters:

domain - String

userName - String

Returns:

RIDList

Throws:

IOException

SMBException

getGroupsForUser

public final RIDList getGroupsForUser(PolicyHandle usrHandle)
                               throws IOException,
                                      SMBException

Return the list of groups that the user has membership of

Parameters:

usrHandle - PolicyHandle

Returns:

RIDList

Throws:

IOException

SMBException

getAliasesForUser

public final RIDList getAliasesForUser(String domain,
                        String userName)
                                throws IOException,
                                       SMBException

Return the list of aliases that the user has membership of

Parameters:

domain - String

userName - String

Returns:

RIDList

Throws:

IOException

SMBException

getAliasesForUser

public final RIDList getAliasesForUser(PolicyHandle domHandle,
                        SID userSID)
                                throws IOException,
                                       SMBException

Return the list of aliases that the user has membership of

Parameters:

domHandle - PolicyHandle

userSID - SID

Returns:

RIDList

Throws:

IOException

SMBException

queryUserInformation

public final UserInfo queryUserInformation(PolicyHandle usrHandle,
                            int infoLevel)
                                    throws IOException,
                                           SMBException

Return information for the specified user

Parameters:

usrHandle - PolicyHandle

infoLevel - int

Returns:

UserInfo

Throws:

IOException

SMBException

closeHandle

public final void closeHandle(PolicyHandle handle)
                       throws IOException,
                              SMBException

Close the remote SAM service

Parameters:

handle - PolicyHandle

Throws:

IOException

SMBException

ClosePipe

public void ClosePipe()
               throws IOException,
                      SMBException

Close the pipe

Overrides:

ClosePipe in class IPCPipeFile

Throws:

IOException

SMBException

clearCaches

public final void clearCaches()
                       throws IOException,
                              SMBException

Clear the domain SID and policy handle caches. This will close all domain handles.

Throws:

IOException

SMBException