1 /*
2 Licensed under the Apache License, Version 2.0 (the "License");
3 you may not use this file except in compliance with the License.
4 You may obtain a copy of the License at
5
6 http://www.apache.org/licenses/LICENSE-2.0
7
8 Unless required by applicable law or agreed to in writing, software
9 distributed under the License is distributed on an "AS IS" BASIS,
10 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 See the License for the specific language governing permissions and
12 limitations under the License.
13 */
14 package uk.nhs.interoperability.infrastructure;
15
16
17 /**
18 * Interface representing a logical identity of a person or system
19 * typically used for audit purposes.
20 * The identity is made up of two parts: the type which defaults to an ITK Identity, and the uri
21 * which contains the actual value.
22 *
23 * @author Michael Odling-Smee
24 * @author Nicholas Jones
25 * @since version 0.1
26 *
27 */
28 public interface ITKIdentity {
29
30 /**
31 * The OID representing the default (ITK) address type.
32 */
33 public static final String DEFAULT_IDENTITY_TYPE = "2.16.840.1.113883.2.1.3.2.4.18.22";
34
35 /**
36 * Allows the identity type to be specified if it is not the {@link #DEFAULT_IDENTITY_TYPE}
37 * @param type The OID representing the address type
38 */
39 public void setType(String type);
40
41 /**
42 * Obtains the identity type
43 * @return the OID representing the type of identity
44 */
45 public String getType();
46
47 /**
48 * Set the URI for this identity
49 * @param uRI the URI to set
50 */
51 public void setURI(String uRI);
52
53 /**
54 * Obtain the URI associated with this identity
55 */
56 public String getURI();
57
58 }