Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Claudine Chiu | 31ad527 | 2016-02-17 20:56:24 +0000 | [diff] [blame] | 17 | package org.onosproject.net.key; |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 18 | |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 19 | import org.onlab.util.Identifier; |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 20 | |
Jordan Halterman | 0d89ea3 | 2017-06-13 10:42:36 -0700 | [diff] [blame] | 21 | import static com.google.common.base.Preconditions.checkArgument; |
| 22 | |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 23 | /** |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 24 | * Device key identifier backed by a string value. |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 25 | */ |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 26 | public final class DeviceKeyId extends Identifier<String> { |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 27 | |
Jordan Halterman | 0d89ea3 | 2017-06-13 10:42:36 -0700 | [diff] [blame] | 28 | private static final int ID_MAX_LENGTH = 1024; |
| 29 | |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 30 | /** |
| 31 | * Constructor for serialization. |
| 32 | */ |
| 33 | private DeviceKeyId() { |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 34 | super(); |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 35 | } |
| 36 | |
| 37 | /** |
| 38 | * Constructs the ID corresponding to a given string value. |
| 39 | * |
| 40 | * @param value the underlying value of this ID |
| 41 | */ |
| 42 | private DeviceKeyId(String value) { |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 43 | super(value); |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 44 | } |
| 45 | |
| 46 | /** |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 47 | * Creates a new device key identifier. |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 48 | * |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 49 | * @param id backing identifier value |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 50 | * @return device key identifier |
| 51 | */ |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 52 | public static DeviceKeyId deviceKeyId(String id) { |
Jordan Halterman | 0d89ea3 | 2017-06-13 10:42:36 -0700 | [diff] [blame] | 53 | if (id != null) { |
| 54 | checkArgument(id.length() <= ID_MAX_LENGTH, "id exceeds maximum length " + ID_MAX_LENGTH); |
| 55 | } |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 56 | return new DeviceKeyId(id); |
| 57 | } |
| 58 | |
Brian Stanke | 2b4f32d | 2016-02-03 14:22:10 -0500 | [diff] [blame] | 59 | } |