Module jcifs
Package org.codelibs.jcifs.smb.internal.dfs

Class Referral

java.lang.Object
org.codelibs.jcifs.smb.internal.dfs.Referral
All Implemented Interfaces:
Decodable
public class Referral extends Object implements Decodable
Represents a DFS (Distributed File System) referral entry containing server redirection information. This class handles DFS referral responses that redirect clients to alternate servers for accessing distributed file system resources, supporting multiple DFS versions and referral types.

  • Constructor Details

    • Referral

      public Referral()
      Default constructor for Referral.

  • Method Details

    • getVersion

      public final int getVersion()
      Gets the DFS referral version number.
      Returns:
      the version

    • getSize

      public final int getSize()
      Gets the size of this referral entry in bytes.
      Returns:
      the size

    • getServerType

      public final int getServerType()
      Gets the server type of this referral.
      Returns:
      the serverType

    • getRFlags

      public final int getRFlags()
      Gets the referral flags.
      Returns:
      the rflags

    • getProximity

      public final int getProximity()
      Gets the proximity value indicating the distance to the target.
      Returns:
      the proximity

    • getAltPath

      public final String getAltPath()
      Gets the alternate path for this referral.
      Returns:
      the altPath

    • getTtl

      public final int getTtl()
      Gets the time-to-live value for this referral in seconds.
      Returns:
      the ttl

    • getRpath

      public final String getRpath()
      Gets the referral path.
      Returns:
      the rpath

    • getNode

      public final String getNode()
      Gets the node name for this referral.
      Returns:
      the node

    • getSpecialName

      public final String getSpecialName()
      Gets the special name for this referral.
      Returns:
      the specialName

    • getExpandedNames

      public final String[] getExpandedNames()
      Gets the expanded names array for this referral.
      Returns:
      the expandedNames

    • decode

      public int decode(byte[] buffer, int bufferIndex, int len)
      Description copied from interface: Decodable
      Decode data from a byte buffer
      Specified by:
      decode in interface Decodable
      Parameters:
      buffer - the byte buffer containing the data to decode
      bufferIndex - the starting index in the buffer
      len - the maximum length of data to decode
      Returns:
      decoded length

    • toString

      public String toString()
      Overrides:
      toString in class Object