Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 Open Networking Laboratory |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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 |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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. |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.core; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 17 | // FIXME: Move to org.onosproject.app package |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 18 | |
| 19 | import java.util.Set; |
| 20 | |
| 21 | /** |
| 22 | * Manages application IDs. |
| 23 | */ |
| 24 | public interface ApplicationIdStore { |
| 25 | |
| 26 | /** |
| 27 | * Returns the set of currently registered application identifiers. |
| 28 | * |
| 29 | * @return set of application ids |
| 30 | */ |
| 31 | Set<ApplicationId> getAppIds(); |
| 32 | |
| 33 | /** |
| 34 | * Returns an existing application id from a given id. |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 35 | * |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 36 | * @param id the short value of the id |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 37 | * @return an application id; null if no such app registered |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 38 | */ |
| 39 | ApplicationId getAppId(Short id); |
| 40 | |
| 41 | /** |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 42 | * Returns registered application id from the given name. |
| 43 | * |
| 44 | * @param name application name |
| 45 | * @return an application id; null if no such app registered |
| 46 | */ |
| 47 | ApplicationId getAppId(String name); |
| 48 | |
| 49 | /** |
Thomas Vachuska | e0f804a | 2014-10-27 23:40:48 -0700 | [diff] [blame] | 50 | * Registers a new application by its name, which is expected |
| 51 | * to follow the reverse DNS convention, e.g. |
| 52 | * {@code org.flying.circus.app} |
| 53 | * |
| 54 | * @param identifier string identifier |
| 55 | * @return the application id |
| 56 | */ |
| 57 | ApplicationId registerApplication(String identifier); |
| 58 | |
| 59 | } |