HandleItem Class

Package:

com.azure.storage.file.share.models

Maven Artifact:

com.azure:azure-storage-file-share:12.22.0

• java.lang.Object
• • com.azure.storage.file.share.models.HandleItem

Implements

XmlSerializable<HandleItem>

public final class HandleItem
implements XmlSerializable<HandleItem>

A listed Azure Storage handle item.

Constructor Summary

Constructor	Description
HandleItem()	Creates an instance of HandleItem class.

Method Summary

Modifier and Type	Method and Description
static HandleItem	fromXml(XmlReader xmlReader) Reads an instance of HandleItem from the XmlReader.
static HandleItem	fromXml(XmlReader xmlReader, String rootElementName) Reads an instance of HandleItem from the XmlReader.
List<ShareFileHandleAccessRights>	getAccessRights() Get the accessRights property: The ShareFileHandleAccessRights property.
String	getClientIp() Get the clientIp property: Client IP that opened the handle.
String	getClientName() Get the clientName property: Name of the client machine where the share is being mounted.
String	getFileId() Get the fileId property: FileId uniquely identifies the file or directory.
String	getHandleId() Get the handleId property: XSMB service handle ID.
OffsetDateTime	getLastReconnectTime() Get the lastReconnectTime property: Time handle was last connected to (UTC).
OffsetDateTime	getOpenTime() Get the openTime property: Time when the session that previously opened the handle has last been reconnected.
String	getParentId() Get the parentId property: ParentId uniquely identifies the parent directory of the object.
String	getPath() Get the path property: File or directory name including full path starting from share root.
String	getSessionId() Get the sessionId property: SMB session ID in context of which the file handle was opened.
HandleItem	setAccessRights(List<ShareFileHandleAccessRights> accessRights) Set the accessRights property: The ShareFileHandleAccessRights property.
HandleItem	setClientIp(String clientIp) Set the clientIp property: Client IP that opened the handle.
HandleItem	setClientName(String clientName) Set the clientName property: Name of the client machine where the share is being mounted.
HandleItem	setFileId(String fileId) Set the fileId property: FileId uniquely identifies the file or directory.
HandleItem	setHandleId(String handleId) Set the handleId property: XSMB service handle ID.
HandleItem	setLastReconnectTime(OffsetDateTime lastReconnectTime) Set the lastReconnectTime property: Time handle was last connected to (UTC).
HandleItem	setOpenTime(OffsetDateTime openTime) Set the openTime property: Time when the session that previously opened the handle has last been reconnected.
HandleItem	setParentId(String parentId) Set the parentId property: ParentId uniquely identifies the parent directory of the object.
HandleItem	setPath(String path) Set the path property: File or directory name including full path starting from share root.
HandleItem	setSessionId(String sessionId) Set the sessionId property: SMB session ID in context of which the file handle was opened.
XmlWriter	toXml(XmlWriter xmlWriter)
XmlWriter	toXml(XmlWriter xmlWriter, String rootElementName)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

HandleItem

public HandleItem()

Creates an instance of HandleItem class.

Method Details

fromXml

public static HandleItem fromXml(XmlReader xmlReader)

Reads an instance of HandleItem from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

An instance of HandleItem if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

fromXml

public static HandleItem fromXml(XmlReader xmlReader, String rootElementName)

Reads an instance of HandleItem from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

rootElementName - Optional root element name to override the default defined by the model. Used to support cases where the model can deserialize from different root element names.

Returns:

An instance of HandleItem if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

getAccessRights

public List getAccessRights()

Get the accessRights property: The ShareFileHandleAccessRights property.

Returns:

the accessRights list value.

getClientIp

public String getClientIp()

Get the clientIp property: Client IP that opened the handle.

Returns:

the clientIp value.

getClientName

public String getClientName()

Get the clientName property: Name of the client machine where the share is being mounted.

Returns:

the clientName value.

getFileId

public String getFileId()

Get the fileId property: FileId uniquely identifies the file or directory.

Returns:

the fileId value.

getHandleId

public String getHandleId()

Get the handleId property: XSMB service handle ID.

Returns:

the handleId value.

getLastReconnectTime

public OffsetDateTime getLastReconnectTime()

Get the lastReconnectTime property: Time handle was last connected to (UTC).

Returns:

the lastReconnectTime value.

getOpenTime

public OffsetDateTime getOpenTime()

Get the openTime property: Time when the session that previously opened the handle has last been reconnected. (UTC).

Returns:

the openTime value.

getParentId

public String getParentId()

Get the parentId property: ParentId uniquely identifies the parent directory of the object.

Returns:

the parentId value.

getPath

public String getPath()

Get the path property: File or directory name including full path starting from share root.

Returns:

the path value.

getSessionId

public String getSessionId()

Get the sessionId property: SMB session ID in context of which the file handle was opened.

Returns:

the sessionId value.

setAccessRights

public HandleItem setAccessRights(List accessRights)

Set the accessRights property: The ShareFileHandleAccessRights property.

Parameters:

accessRights - the accessRights list to set.

Returns:

the HandleItem object itself.

setClientIp

public HandleItem setClientIp(String clientIp)

Set the clientIp property: Client IP that opened the handle.

Parameters:

clientIp - the clientIp value to set.

Returns:

the HandleItem object itself.

setClientName

public HandleItem setClientName(String clientName)

Set the clientName property: Name of the client machine where the share is being mounted.

Parameters:

clientName - the clientName value to set.

Returns:

the HandleItem object itself.

setFileId

public HandleItem setFileId(String fileId)

Set the fileId property: FileId uniquely identifies the file or directory.

Parameters:

fileId - the fileId value to set.

Returns:

the HandleItem object itself.

setHandleId

public HandleItem setHandleId(String handleId)

Set the handleId property: XSMB service handle ID.

Parameters:

handleId - the handleId value to set.

Returns:

the HandleItem object itself.

setLastReconnectTime

public HandleItem setLastReconnectTime(OffsetDateTime lastReconnectTime)

Set the lastReconnectTime property: Time handle was last connected to (UTC).

Parameters:

lastReconnectTime - the lastReconnectTime value to set.

Returns:

the HandleItem object itself.

setOpenTime

public HandleItem setOpenTime(OffsetDateTime openTime)

Set the openTime property: Time when the session that previously opened the handle has last been reconnected. (UTC).

Parameters:

openTime - the openTime value to set.

Returns:

the HandleItem object itself.

setParentId

public HandleItem setParentId(String parentId)

Set the parentId property: ParentId uniquely identifies the parent directory of the object.

Parameters:

parentId - the parentId value to set.

Returns:

the HandleItem object itself.

setPath

public HandleItem setPath(String path)

Set the path property: File or directory name including full path starting from share root.

Parameters:

path - the path value to set.

Returns:

the HandleItem object itself.

setSessionId

public HandleItem setSessionId(String sessionId)

Set the sessionId property: SMB session ID in context of which the file handle was opened.

Parameters:

sessionId - the sessionId value to set.

Returns:

the HandleItem object itself.

toXml

public XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

XMLStreamException

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter

rootElementName

Throws:

XMLStreamException