Documentation
¶
Index ¶
- Constants
- func GetFileOpenFlagSeekToEnd(mode FileOpenMode) (int, bool)
- func IsFileNotFoundError(err error) bool
- func IsFileOpenFlagOpeningExisting(mode FileOpenMode) bool
- func IsFileOpenFlagRead(mode FileOpenMode) bool
- func IsFileOpenFlagWrite(mode FileOpenMode) bool
- type AuthScheme
- type CSNegotiationPolicy
- type CSNegotiationRequire
- type ColumnType
- type FileNotFoundError
- type FileOpenFlag
- type FileOpenMode
- type IRODSAccess
- type IRODSAccount
- func CreateIRODSAccount(host string, port int, user string, zone string, authScheme AuthScheme, ...) (*IRODSAccount, error)
- func CreateIRODSAccountFromYAML(yamlBytes []byte) (*IRODSAccount, error)
- func CreateIRODSProxyAccount(host string, port int, clientUser string, clientZone string, proxyUser string, ...) (*IRODSAccount, error)
- type IRODSCollection
- type IRODSColumn
- type IRODSDataObject
- type IRODSFileHandle
- type IRODSMeta
- type IRODSMetaCollection
- type IRODSMetaItemType
- type IRODSReplica
- type IRODSSSLConfig
- type IRODSUser
- type IRODSUserGroup
- type IRODSVersion
- type IRODSZone
- type Whence
Constants ¶
const (
PamTTLDefault int = 1
)
Variables ¶
This section is empty.
Functions ¶
func GetFileOpenFlagSeekToEnd ¶
func GetFileOpenFlagSeekToEnd(mode FileOpenMode) (int, bool)
GetFileOpenFlagSeekToEnd ...
func IsFileNotFoundError ¶
IsFileNotFoundError evaluates if the given error is FileNotFoundError
func IsFileOpenFlagOpeningExisting ¶
func IsFileOpenFlagOpeningExisting(mode FileOpenMode) bool
IsFileOpenFlagOpeningExisting ...
Types ¶
type AuthScheme ¶
type AuthScheme string
AuthScheme defines Authentication Scheme
const ( // AuthSchemeNative uses Native authentication scheme AuthSchemeNative AuthScheme = "native" // AuthSchemeGSI uses GSI authentication scheme AuthSchemeGSI AuthScheme = "gsi" // AuthSchemePAM uses PAM authentication scheme AuthSchemePAM AuthScheme = "pam" )
func GetAuthScheme ¶
func GetAuthScheme(authScheme string) (AuthScheme, error)
GetAuthScheme returns AuthScheme value from string
type CSNegotiationPolicy ¶
type CSNegotiationPolicy string
CSNegotiationPolicy defines Negotiation result
const ( // CSNegotiationFailure presents negotiation is failed CSNegotiationFailure CSNegotiationPolicy = "CS_NEG_FAILURE" // CSNegotiationUseTCP uses Plain TCP connection CSNegotiationUseTCP CSNegotiationPolicy = "CS_NEG_USE_TCP" // CSNegotiationUseSSL uses SSL connection CSNegotiationUseSSL CSNegotiationPolicy = "CS_NEG_USE_SSL" )
func GetCSNegotiationPolicy ¶
func GetCSNegotiationPolicy(policy string) (CSNegotiationPolicy, error)
GetCSNegotiationPolicy returns CSNegotiationPolicy value from string
func PerformCSNegotiation ¶
func PerformCSNegotiation(clientRequest CSNegotiationRequire, serverRequest CSNegotiationRequire) (CSNegotiationPolicy, int)
PerformCSNegotiation performs CSNegotiation and returns the policy determined
type CSNegotiationRequire ¶
type CSNegotiationRequire string
CSNegotiationRequire defines Negotiation request
const ( // CSNegotiationRequireTCP requires Plain TCP connection CSNegotiationRequireTCP CSNegotiationRequire = "CS_NEG_REFUSE" // CSNegotiationRequireSSL requires SSL connection CSNegotiationRequireSSL CSNegotiationRequire = "CS_NEG_REQUIRE" // CSNegotiationDontCare requires any of TCP or SSL connection CSNegotiationDontCare CSNegotiationRequire = "CS_NEG_DONT_CARE" )
func GetCSNegotiationRequire ¶
func GetCSNegotiationRequire(require string) (CSNegotiationRequire, error)
GetCSNegotiationRequire returns CSNegotiationRequire value from string
type ColumnType ¶
type ColumnType string
const ( ColumnTypeInteger ColumnType = "Integer" ColumnTypeString ColumnType = "String" ColumnTypeDateTime ColumnType = "DateTime" )
type FileNotFoundError ¶
type FileNotFoundError struct {
// contains filtered or unexported fields
}
FileNotFoundError ...
func NewFileNotFoundError ¶
func NewFileNotFoundError(message string) *FileNotFoundError
NewFileNotFoundError creates FileNotFoundError struct
func NewFileNotFoundErrorf ¶
func NewFileNotFoundErrorf(format string, v ...interface{}) *FileNotFoundError
NewFileNotFoundErrorf creates FileNotFoundError struct
func (*FileNotFoundError) Error ¶
func (e *FileNotFoundError) Error() string
type FileOpenFlag ¶
type FileOpenFlag int
const ( O_RDONLY FileOpenFlag = 0 O_WRONLY FileOpenFlag = 1 O_RDWR FileOpenFlag = 2 O_APPEND FileOpenFlag = 1024 O_CREAT FileOpenFlag = 64 O_EXCL FileOpenFlag = 128 O_TRUNC FileOpenFlag = 512 )
type FileOpenMode ¶
type FileOpenMode string
const ( FileOpenModeReadOnly FileOpenMode = "r" FileOpenModeReadWrite FileOpenMode = "r+" FileOpenModeWriteOnly FileOpenMode = "w" FileOpenModeWriteTruncate FileOpenMode = "w+" FileOpenModeAppend FileOpenMode = "a" FileOpenModeReadAppend FileOpenMode = "a+" )
type IRODSAccess ¶
IRODSAccess contains irods access information
func (*IRODSAccess) ToString ¶
func (access *IRODSAccess) ToString() string
ToString stringifies the object
type IRODSAccount ¶
type IRODSAccount struct {
AuthenticationScheme AuthScheme
ClientServerNegotiation bool
CSNegotiationPolicy CSNegotiationRequire
Host string
Port int
ClientUser string
ClientZone string
ProxyUser string
ProxyZone string
ServerDN string
Password string
PamTTL int
SSLConfiguration *IRODSSSLConfig
}
IRODSAccount contains irods login information
func CreateIRODSAccount ¶
func CreateIRODSAccount(host string, port int, user string, zone string, authScheme AuthScheme, password string, serverDN string) (*IRODSAccount, error)
CreateIRODSAccount creates IRODSAccount
func CreateIRODSAccountFromYAML ¶
func CreateIRODSAccountFromYAML(yamlBytes []byte) (*IRODSAccount, error)
CreateIRODSAccountFromYAML creates IRODSAccount from YAML
func CreateIRODSProxyAccount ¶
func CreateIRODSProxyAccount(host string, port int, clientUser string, clientZone string, proxyUser string, proxyZone string, authScheme AuthScheme, password string) (*IRODSAccount, error)
CreateIRODSProxyAccount creates IRODSAccount for proxy access
func (*IRODSAccount) MaskSensitiveData ¶
func (account *IRODSAccount) MaskSensitiveData() *IRODSAccount
MaskSensitiveData returns IRODSAccount object with sensitive data masked
func (*IRODSAccount) SetSSLConfiguration ¶
func (account *IRODSAccount) SetSSLConfiguration(sslConf *IRODSSSLConfig)
SetSSLConfiguration sets SSL Configuration
func (*IRODSAccount) UseProxyAccess ¶
func (account *IRODSAccount) UseProxyAccess() bool
UseProxyAccess returns whether it uses proxy access or not
type IRODSCollection ¶
type IRODSCollection struct {
ID int64
// Path has an absolute path to the collection
Path string
// Name has only the name part of the path
Name string
// Owner has the owner's name
Owner string
// CreateTime has creation time
CreateTime time.Time
// ModifyTime has last modified time
ModifyTime time.Time
}
IRODSCollection contains irods collection information
func (*IRODSCollection) ToString ¶
func (coll *IRODSCollection) ToString() string
ToString stringifies the object
type IRODSColumn ¶
type IRODSColumn struct {
Type ColumnType
ICatKey string
ICatID int
}
IRODSColumn ..
type IRODSDataObject ¶
type IRODSDataObject struct {
ID int64
CollectionID int64
// Path has an absolute path to the data object
Path string
// Name has only the name part of the path
Name string
// Size has the file size
Size int64
// Attributes has attributes
//Attributes string
// Replicas has replication information
Replicas []*IRODSReplica
}
IRODSDataObject contains irods data object information
func (*IRODSDataObject) ToString ¶
func (obj *IRODSDataObject) ToString() string
ToString stringifies the object
type IRODSFileHandle ¶
type IRODSFileHandle struct {
FileDescriptor int
// Path has an absolute path to the data object
Path string
}
IRODSFileHandle contains file handle
func (*IRODSFileHandle) ToString ¶
func (handle *IRODSFileHandle) ToString() string
ToString stringifies the object
type IRODSMeta ¶
type IRODSMeta struct {
AVUID int64 // is ignored on metadata operations (set, add, mod, rm)
Name string
Value string
Units string
}
IRODSMeta contains irods metadata
type IRODSMetaCollection ¶
type IRODSMetaCollection struct {
Path string
}
IRODSMetaCollection contains irods data object information
func (*IRODSMetaCollection) ToString ¶
func (meta *IRODSMetaCollection) ToString() string
ToString stringifies the object
type IRODSMetaItemType ¶ added in v0.2.0
type IRODSMetaItemType string
IRODSMetaItemType describes a type to set metadata on
const ( IRODSDataObjectMetaItemType IRODSMetaItemType = "-d" IRODSCollectionMetaItemType IRODSMetaItemType = "-C" IRODSResourceMetaItemType IRODSMetaItemType = "-R" IRODSUserMetaItemType IRODSMetaItemType = "-u" )
func GetIRODSMetaItemType ¶ added in v0.2.0
func GetIRODSMetaItemType(data interface{}) (IRODSMetaItemType, error)
GetIRODSMetaItemType gets the irods metadata item type from an object.
type IRODSReplica ¶
type IRODSReplica struct {
Number int64
// Owner has the owner's name
Owner string
// CheckSum has the checksum of the file
CheckSum string
Status string
ResourceName string
// Path has an absolute path to the data object
Path string
ResourceHierarchy string
// CreateTime has creation time
CreateTime time.Time
// ModifyTime has last modified time
ModifyTime time.Time
}
IRODSReplica contains irods data object replication information
func (*IRODSReplica) ToString ¶
func (obj *IRODSReplica) ToString() string
ToString stringifies the object
type IRODSSSLConfig ¶
type IRODSSSLConfig struct {
CACertificateFile string
EncryptionKeySize int
EncryptionAlgorithm string
SaltSize int
HashRounds int
}
IRODSSSLConfig contains irods ssl configuration
func CreateIRODSSSLConfig ¶
func CreateIRODSSSLConfig(caCertFile string, keySize int, algorithm string, saltSize int, hashRounds int) (*IRODSSSLConfig, error)
CreateIRODSSSLConfig creates IRODSSSLConfig
func (*IRODSSSLConfig) ReadCACert ¶
func (config *IRODSSSLConfig) ReadCACert() ([]byte, error)
ReadCACert returns CA Cert data
type IRODSUserGroup ¶
IRODSUserGroup contains irods user group information
func (*IRODSUserGroup) ToString ¶
func (group *IRODSUserGroup) ToString() string
ToString stringifies the object
type IRODSVersion ¶
type IRODSVersion struct {
ReleaseVersion string
APIVersion string
ReconnectPort int
ReconnectAddr string
Cookie int
}
IRODSVersion contains irods version information