ShareInfo (Alfresco JLan 6.2 API)

java.lang.Object
- org.alfresco.jlan.smb.dcerpc.info.ShareInfo

All Implemented Interfaces:

DCEReadable, DCEWriteable

Direct Known Subclasses:

RAPShareInfo
```
public class ShareInfo
extends Object
implements DCEWriteable, DCEReadable
```
Share Information Class
Holds the details of a share from a DCE/RPC request/response.

Author:

gkspencer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`All`
`static int`	`Attrib`
`static int`	`Create`
`static int`	`Delete`
`static int`	`Device`
`static int`	`Disk`
`static int`	`Execute`
`static int`	`Hidden`
`static int`	`InfoLevel0`
`static int`	`InfoLevel1`
`static int`	`InfoLevel1005`
`static int`	`InfoLevel2`
`static int`	`InfoLevel502`
`static int`	`IPC`
`static int`	`Perm`
`static int`	`PrintQueue`
`static int`	`Read`
`static int`	`Write`

Constructor Summary

Constructors
Constructor and Description
`ShareInfo()` Class constructor
`ShareInfo(int lev)` Class constructor
`ShareInfo(int lev, String name, int typ, String comment)` Class constructor

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`clearStrings()` Clear all string values
`String`	`getComment()` Return the comment
`int`	`getCurrentUsers()` Return the current number of users
`int`	`getFlags()` Get the share flags
`int`	`getInformationLevel()` Return the information level
`int`	`getMaximumUsers()` Return the maximum number of users allowed
`String`	`getName()` Return the share name
`String`	`getPassword()` Return the share password
`String`	`getPath()` Return the share local path
`int`	`getPermissions()` Return the share permissions
`int`	`getType()` Return the share type
`String`	`getTypeAsString()` Return the share type as a string
`boolean`	`isDevice()` Check if this is a device share
`boolean`	`isDisk()` Check if this is a disk share
`boolean`	`isHidden()` Check if this share is a hidden/admin share
`boolean`	`isNamedPipe()` Check if this is a named pipe share
`boolean`	`isPrinter()` Check if this is a printer share
`void`	`readObject(DCEBuffer buf)` Read the share information from the DCE/RPC buffer
`void`	`readStrings(DCEBuffer buf)` Read the strings for this share from the DCE/RPC buffer
`void`	`setComment(String str)` Set the share comment
`void`	`setCurrentUsers(int curUsers)` Set the current number of users
`void`	`setFlags(int flags)` Set the share flags
`void`	`setInformationLevel(int lev)` Set the information level
`void`	`setMaximumUsers(int maxUsers)` Set the maximum number of users
`void`	`setName(String name)` Set the share name
`void`	`setPath(String path)` Set the local path
`void`	`setPermissions(int perm)` Set the share permissions
`void`	`setType(int typ)` Set the share type
`String`	`toString()` Return the share information as a string
`void`	`writeObject(DCEBuffer buf, DCEBuffer strBuf)` Write the share information to the DCE buffer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - InfoLevel0
```
public static final int InfoLevel0
```
    See Also:
    Constant Field Values
  - InfoLevel1
```
public static final int InfoLevel1
```
    See Also:
    Constant Field Values
  - InfoLevel2
```
public static final int InfoLevel2
```
    See Also:
    Constant Field Values
  - InfoLevel502
```
public static final int InfoLevel502
```
    See Also:
    Constant Field Values
  - InfoLevel1005
```
public static final int InfoLevel1005
```
    See Also:
    Constant Field Values
  - Disk
```
public static final int Disk
```
    See Also:
    Constant Field Values
  - PrintQueue
```
public static final int PrintQueue
```
    See Also:
    Constant Field Values
  - Device
```
public static final int Device
```
    See Also:
    Constant Field Values
  - IPC
```
public static final int IPC
```
    See Also:
    Constant Field Values
  - Hidden
```
public static final int Hidden
```
    See Also:
    Constant Field Values
  - Read
```
public static final int Read
```
    See Also:
    Constant Field Values
  - Write
```
public static final int Write
```
    See Also:
    Constant Field Values
  - Create
```
public static final int Create
```
    See Also:
    Constant Field Values
  - Execute
```
public static final int Execute
```
    See Also:
    Constant Field Values
  - Delete
```
public static final int Delete
```
    See Also:
    Constant Field Values
  - Attrib
```
public static final int Attrib
```
    See Also:
    Constant Field Values
  - Perm
```
public static final int Perm
```
    See Also:
    Constant Field Values
  - All
```
public static final int All
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ShareInfo
```
public ShareInfo()
```
    Class constructor
  - ShareInfo
```
public ShareInfo(int lev)
```
    Class constructor
    
    Parameters:
    lev - int
  - ShareInfo
```
public ShareInfo(int lev,
         String name,
         int typ,
         String comment)
```
    Class constructor
    
    Parameters:
    lev - int
    name - String
    typ - int
    comment - String
- Method Detail
  - getInformationLevel
```
public final int getInformationLevel()
```
    Return the information level
    
    Returns:
    int
  - getName
```
public final String getName()
```
    Return the share name
    
    Returns:
    String
  - getType
```
public final int getType()
```
    Return the share type
    
    Returns:
    int
  - getFlags
```
public final int getFlags()
```
    Get the share flags
    
    Returns:
    int
  - isHidden
```
public final boolean isHidden()
```
    Check if this share is a hidden/admin share
    
    Returns:
    boolean
  - isDisk
```
public final boolean isDisk()
```
    Check if this is a disk share
    
    Returns:
    boolean
  - isPrinter
```
public final boolean isPrinter()
```
    Check if this is a printer share
    
    Returns:
    boolean
  - isDevice
```
public final boolean isDevice()
```
    Check if this is a device share
    
    Returns:
    boolean
  - isNamedPipe
```
public final boolean isNamedPipe()
```
    Check if this is a named pipe share
    
    Returns:
    boolean
  - getPermissions
```
public final int getPermissions()
```
    Return the share permissions
    
    Returns:
    int
  - getMaximumUsers
```
public final int getMaximumUsers()
```
    Return the maximum number of users allowed
    
    Returns:
    int
  - getCurrentUsers
```
public final int getCurrentUsers()
```
    Return the current number of users
    
    Returns:
    int
  - getPath
```
public final String getPath()
```
    Return the share local path
    
    Returns:
    String
  - getPassword
```
public final String getPassword()
```
    Return the share password
    
    Returns:
    String
  - getTypeAsString
```
public final String getTypeAsString()
```
    Return the share type as a string
    
    Returns:
    String
  - getComment
```
public final String getComment()
```
    Return the comment
    
    Returns:
    String
  - setInformationLevel
```
public final void setInformationLevel(int lev)
```
    Set the information level
    
    Parameters:
    lev - int
  - setType
```
public final void setType(int typ)
```
    Set the share type
    
    Parameters:
    typ - int
  - setFlags
```
public final void setFlags(int flags)
```
    Set the share flags
    
    Parameters:
    flags - int
  - setName
```
public final void setName(String name)
```
    Set the share name
    
    Parameters:
    name - String
  - setComment
```
public final void setComment(String str)
```
    Set the share comment
    
    Parameters:
    str - String
  - setPermissions
```
public final void setPermissions(int perm)
```
    Set the share permissions
    
    Parameters:
    perm - int
  - setMaximumUsers
```
public final void setMaximumUsers(int maxUsers)
```
    Set the maximum number of users
    
    Parameters:
    maxUsers - int
  - setCurrentUsers
```
public final void setCurrentUsers(int curUsers)
```
    Set the current number of users
    
    Parameters:
    curUsers - int
  - setPath
```
public final void setPath(String path)
```
    Set the local path
    
    Parameters:
    path - String
  - clearStrings
```
protected final void clearStrings()
```
    Clear all string values
  - readObject
```
public void readObject(DCEBuffer buf)
                throws DCEBufferException
```
    Read the share information from the DCE/RPC buffer
    
    Specified by:
    
    readObject in interface DCEReadable
    
    Parameters:
    buf - DCEBuffer
    
    Throws:
    
    DCEBufferException
  - readStrings
```
public void readStrings(DCEBuffer buf)
                 throws DCEBufferException
```
    Read the strings for this share from the DCE/RPC buffer
    
    Specified by:
    
    readStrings in interface DCEReadable
    
    Parameters:
    buf - DCEBuffer
    
    Throws:
    
    DCEBufferException
  - writeObject
```
public void writeObject(DCEBuffer buf,
               DCEBuffer strBuf)
```
    Write the share information to the DCE buffer
    
    Specified by:
    
    writeObject in interface DCEWriteable
    
    Parameters:
    buf - DCEBuffer
    strBuf - DCEBuffer
  - toString
```
public String toString()
```
    Return the share information as a string
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String

Class ShareInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

InfoLevel0

InfoLevel1

InfoLevel2

InfoLevel502

InfoLevel1005

Disk

PrintQueue

Device

IPC

Hidden

Read

Write

Create

Execute

Delete

Attrib

Perm

All

Constructor Detail

ShareInfo

ShareInfo

ShareInfo

Method Detail

getInformationLevel

getName

getType

getFlags

isHidden

isDisk

isPrinter

isDevice

isNamedPipe

getPermissions

getMaximumUsers

getCurrentUsers

getPath

getPassword

getTypeAsString

getComment

setInformationLevel

setType

setFlags

setName

setComment

setPermissions

setMaximumUsers

setCurrentUsers

setPath

clearStrings

readObject

readStrings

writeObject

toString