/
adminstate.go
69 lines (60 loc) · 2.49 KB
/
adminstate.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/*******************************************************************************
* Copyright 2019 Dell Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*******************************************************************************/
package models
import (
"encoding/json"
"fmt"
"strings"
)
// AdminState controls the range of values which constitute valid administrative states for a device
type AdminState string
const (
// Locked : device is locked
// Unlocked : device is unlocked
Locked = "LOCKED"
Unlocked = "UNLOCKED"
)
// UnmarshalJSON implements the Unmarshaler interface for the enum type
func (as *AdminState) UnmarshalJSON(data []byte) error {
// Extract the string from data.
var s string
if err := json.Unmarshal(data, &s); err != nil {
return fmt.Errorf("AdminState should be a string, got %s", data)
}
new := AdminState(strings.ToUpper(s))
*as = new
return nil
}
// Validate satisfies the Validator interface
func (as AdminState) Validate() (bool, error) {
_, found := map[string]AdminState{"LOCKED": Locked, "UNLOCKED": Unlocked}[string(as)]
if !found {
return false, NewErrContractInvalid(fmt.Sprintf("invalid AdminState %q", as))
}
return true, nil
}
// GetAdminState is called from within the router logic of the core services. For example, there are PUT calls
// like the one below from core-metadata which specify their update parameters in the URL
//
// d.HandleFunc("/{"+ID+"}/"+URLADMINSTATE+"/{"+ADMINSTATE+"}", restSetDeviceAdminStateById).Methods(http.MethodPut)
//
// Updates like this should be refactored to pass a body containing the new values instead of via the URL. This
// would allow us to utilize the model validation above and remove the logic from the controller.
//
// This will be removed once work on the following issue begins -- https://github.com/edgexfoundry/edgex-go/issues/1244
func GetAdminState(as string) (AdminState, bool) {
as = strings.ToUpper(as)
retValue, err := map[string]AdminState{"LOCKED": Locked, "UNLOCKED": Unlocked}[as]
return retValue, err
}