Class: Cul::Handles::BaseRequest

Inherits:
BaseMessage show all
Defined in:
lib/cul/handles/base_request.rb

Constant Summary

Constants included from Hdl

Hdl::ENV_FLAG_COMPRESSED, Hdl::ENV_FLAG_ENCRYPTED, Hdl::ENV_FLAG_TRUNCATED, Hdl::INDEX_ADMIN_HANDLE, Hdl::INDEX_AUTH, Hdl::INDEX_MAINTAINER_HANDLE, Hdl::MSG_FLAG_AUTH, Hdl::MSG_FLAG_AUTH_INDEX, Hdl::MSG_FLAG_CACR, Hdl::MSG_FLAG_CACR_INDEX, Hdl::MSG_FLAG_CERT, Hdl::MSG_FLAG_CERT_INDEX, Hdl::MSG_FLAG_CONT, Hdl::MSG_FLAG_CONT_INDEX, Hdl::MSG_FLAG_ENCR, Hdl::MSG_FLAG_ENCR_INDEX, Hdl::MSG_FLAG_KPAL, Hdl::MSG_FLAG_KPAL_INDEX, Hdl::MSG_FLAG_PUBL, Hdl::MSG_FLAG_PUBL_INDEX, Hdl::MSG_FLAG_RECU, Hdl::MSG_FLAG_RECU_INDEX, Hdl::MSG_FLAG_RRDG, Hdl::MSG_FLAG_RRDG_INDEX, Hdl::OC_ADD_VALUE, Hdl::OC_CHALLENGE_RESPONSE, Hdl::OC_CREATE_HANDLE, Hdl::OC_DELETE_HANDLE, Hdl::OC_GET_SITEINFO, Hdl::OC_LIST_HANDLE, Hdl::OC_LIST_NA, Hdl::OC_MODIFY_VALUE, Hdl::OC_REMOVE_VALUE, Hdl::OC_RESERVED, Hdl::OC_RESOLUTION, Hdl::OC_SESSION_EXCHANGEKEY, Hdl::OC_SESSION_SETUP, Hdl::OC_SESSION_TERMINATE, Hdl::OC_VERIFY_RESPONSE, Hdl::PERM_ADD_ADMIN, Hdl::PERM_ADD_HANDLE, Hdl::PERM_ADD_NA, Hdl::PERM_ADD_VALUE, Hdl::PERM_ALL, Hdl::PERM_DELETE_HANDLE, Hdl::PERM_DELETE_NA, Hdl::PERM_LIST_HDLS, Hdl::PERM_MODIFY_ADMIN, Hdl::PERM_MODIFY_VALUE, Hdl::PERM_READ_VALUE, Hdl::PERM_REMOVE_ADMIN, Hdl::PERM_REMOVE_VALUE, Hdl::RC_ACCESS_DENIED, Hdl::RC_AUTHEN_FAILED, Hdl::RC_AUTHEN_NEEDED, Hdl::RC_AUTHEN_TIMEOUT, Hdl::RC_ERROR, Hdl::RC_EXPIRED_SITE_INFO, Hdl::RC_FORWARDED, Hdl::RC_HANDLE_ALREADY_EXIST, Hdl::RC_HANDLE_NOT_FOUND, Hdl::RC_INVALID_CREDENTIAL, Hdl::RC_INVALID_HANDLE, Hdl::RC_NA_DELEGATE, Hdl::RC_NOT_AUTHORIZED, Hdl::RC_NO_SESSION_KEY, Hdl::RC_OPERATION_DENIED, Hdl::RC_PROTOCOL_ERROR, Hdl::RC_QUEUED, Hdl::RC_RECUR_LIMIT_EXCEEDED, Hdl::RC_RESERVED, Hdl::RC_SERVER_BUSY, Hdl::RC_SERVER_NOT_RESP, Hdl::RC_SERVICE_REFERRAL, Hdl::RC_SESSION_FAILED, Hdl::RC_SESSION_KEY_INVALID, Hdl::RC_SESSION_NO_SUPPORT, Hdl::RC_SESSION_TIMEOUT, Hdl::RC_SUCCESS, Hdl::RC_TRYING, Hdl::RC_UNABLE_TO_AUTHEN, Hdl::RC_VALUE_ALREADY_EXIST, Hdl::RC_VALUE_INVALID, Hdl::RC_VALUE_NOT_FOUND

Instance Method Summary collapse

Methods inherited from BaseMessage

#authoritative, #authoritative=, #cacheCertify, #cacheCertify=, #certify, #certify=, #continuous, #continuous=, #digestAlg=, #encrypt, #encrypt=, #keepAlive, #keepAlive=, #publicOnly, #publicOnly=, #recursive, #recursive=, #returnRequestDigest, #returnRequestDigest=

Methods included from Hdl

#asBytes, #calculateValueLen, #convert16t8, #decodeAdminData, #encodeAdminData, #fromBytes, #readByteArray, #readIntArray, #readProtocolString, #toProtocolString

Constructor Details

#initializeBaseRequest

Returns a new instance of BaseRequest.



4
5
6
7
8
9
10
11
12
13
14
# File 'lib/cul/handles/base_request.rb', line 4

def initialize()
  super()
  @body = []
  @opFlag = [0,0,0,0]
  @recursionCount = [0]
  @messageFlag = [0,0]
  @messageLength = [0,0,0,0]    
  @siteInfoSerial = [0xff,0xff]
  @sessionId = [0,0,0,0]
  @credential = [0,0,0,0]
end

Instance Method Details

#bodyObject



131
132
133
# File 'lib/cul/handles/base_request.rb', line 131

def body
  return @body
end

#bodyLengthObject



137
138
139
# File 'lib/cul/handles/base_request.rb', line 137

def bodyLength
  return asBytes(@body.length) 
end

#credentialObject



99
100
101
# File 'lib/cul/handles/base_request.rb', line 99

def credential()
  @credential
end

#credentialDigestAlgObject



91
92
93
# File 'lib/cul/handles/base_request.rb', line 91

def credentialDigestAlg()
  return []
end

#credentialOptionsObject



82
83
84
# File 'lib/cul/handles/base_request.rb', line 82

def credentialOptions()
  return []
end

#credentialReservedObject



79
80
81
# File 'lib/cul/handles/base_request.rb', line 79

def credentialReserved()
  return []
end

#credentialSignerObject



85
86
87
# File 'lib/cul/handles/base_request.rb', line 85

def credentialSigner()
  return []
end

#credentialTypeObject



88
89
90
# File 'lib/cul/handles/base_request.rb', line 88

def credentialType()
  return []
end

#credentialVersionObject



76
77
78
# File 'lib/cul/handles/base_request.rb', line 76

def credentialVersion()
  return []
end

#digest(data) ⇒ Object



140
141
142
# File 'lib/cul/handles/base_request.rb', line 140

def digest(data)
  return @SHA1.digest(data.pack('U*')).unpack('c*')
end

#encodeBodyObject



134
135
136
# File 'lib/cul/handles/base_request.rb', line 134

def encodeBody()
  return
end

#encodeCredentialObject



94
95
96
97
98
# File 'lib/cul/handles/base_request.rb', line 94

def encodeCredential()
  creds = [].concat(self.credentialVersion).concat(self.credentialReserved).concat(self.credentialOptions()).concat(self.credentialSigner).concat(self.credentialType)
  creds = asBytes(creds.length).concat(creds)
  @credential = creds
end

#envelopeObject



105
106
107
108
109
110
111
112
113
# File 'lib/cul/handles/base_request.rb', line 105

def envelope
  e = [@majorVersion, @minorVersion]
  e.concat(@messageFlag)
  e.concat(@sessionId)
  e.concat(@requestId)
  e.concat(@sequenceNumber)
  e.concat(asBytes(@body.length + 24 + @credential.length))
  e
end

#expirationTimeObject



64
65
66
# File 'lib/cul/handles/base_request.rb', line 64

def expirationTime()
  fromBytes(@expirationTime)
end

#expirationTime=(val) ⇒ Object



67
68
69
# File 'lib/cul/handles/base_request.rb', line 67

def expirationTime=(val)
  @expirationTime=asBytes(val)
end

#headerObject



120
121
122
123
124
125
126
127
128
129
130
# File 'lib/cul/handles/base_request.rb', line 120

def header
  result = [].concat(self.opCode)
  result.concat(@responseCode)
  result.concat(@opFlag)
  result.concat(@siteInfoSerial)
  result.concat(@recursionCount)
  result.concat([0])
  result.concat(@expirationTime)
  result.concat(asBytes(@body.length))
  return result
end

#messageFlagObject



114
115
116
# File 'lib/cul/handles/base_request.rb', line 114

def messageFlag
  return @messageFlag
end

#messageFlag=(val) ⇒ Object



102
103
104
# File 'lib/cul/handles/base_request.rb', line 102

def messageFlag=(val)
  @messageFlag = val
end

#messageLengthObject



117
118
119
# File 'lib/cul/handles/base_request.rb', line 117

def messageLength
  @body.length + 24 + @credential.length
end

#opCodeObject



21
22
23
# File 'lib/cul/handles/base_request.rb', line 21

def opCode()
  @opCode
end

#opCode=(val) ⇒ Object



18
19
20
# File 'lib/cul/handles/base_request.rb', line 18

def opCode=(val)
  @opCode=asBytes(val)
end

#opFlagObject



27
28
29
# File 'lib/cul/handles/base_request.rb', line 27

def opFlag()
  fromBytes(@opFlag)
end

#opFlag=(val) ⇒ Object



24
25
26
# File 'lib/cul/handles/base_request.rb', line 24

def opFlag=(val)
  @opFlag=asBytes(val)
end

#packetObject



143
144
145
146
147
148
149
150
# File 'lib/cul/handles/base_request.rb', line 143

def packet
  encodeBody()
  encodeCredential()
  result =  envelope().concat(header())
  result.concat(body())
  result.concat(credential())
  return result
end

#recursionCountObject



58
59
60
# File 'lib/cul/handles/base_request.rb', line 58

def recursionCount()
  fromBytes(@recursionCount)
end

#recursionCount=(val) ⇒ Object



61
62
63
# File 'lib/cul/handles/base_request.rb', line 61

def recursionCount=(val)
  @recursionCount=asBytes(val)
end

#requestIdObject



33
34
35
# File 'lib/cul/handles/base_request.rb', line 33

def requestId()
  fromBytes(@requestId)
end

#requestId=(val) ⇒ Object



30
31
32
# File 'lib/cul/handles/base_request.rb', line 30

def requestId=(val)
  @requestId=asBytes(val)
end

#responseCodeObject



73
74
75
# File 'lib/cul/handles/base_request.rb', line 73

def responseCode
  @responseCode
end

#responseCode=(val) ⇒ Object



70
71
72
# File 'lib/cul/handles/base_request.rb', line 70

def responseCode=(val)
  @responseCode=asBytes(val)
end

#sequenceNumberObject



52
53
54
# File 'lib/cul/handles/base_request.rb', line 52

def sequenceNumber()
  fromBytes(@sequenceNumber)
end

#sequenceNumber=(val) ⇒ Object



55
56
57
# File 'lib/cul/handles/base_request.rb', line 55

def sequenceNumber=(val)
  @sequenceNumber=asBytes(val)
end

#sessionIdObject



39
40
41
# File 'lib/cul/handles/base_request.rb', line 39

def sessionId()
  @sessionId
end

#sessionId=(val) ⇒ Object



36
37
38
# File 'lib/cul/handles/base_request.rb', line 36

def sessionId=(val)
  @sessionId=asBytes(val)
end

#siteInfoSerialObject



49
50
51
# File 'lib/cul/handles/base_request.rb', line 49

def siteInfoSerial()
  return fromBytes(@siteInfoSerial)
end

#siteInfoSerial=(val) ⇒ Object



42
43
44
45
46
47
48
# File 'lib/cul/handles/base_request.rb', line 42

def siteInfoSerial=(val)
  if val < 0
    @siteInfoSerial=asBytes(65536 + val)[-2..-1]
  else
    @siteInfoSerial = asBytes(val)[-2..-1]
  end
end

#valid?Boolean

Returns:

  • (Boolean)


15
16
17
# File 'lib/cul/handles/base_request.rb', line 15

def valid?()
  return true
end