diff options
author | 2015-09-09 22:15:21 -0700 | |
---|---|---|
committer | 2015-09-09 22:15:21 -0700 | |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/core/api/src/main/java/org/onosproject/core/CoreService.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/core/CoreService.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/core/CoreService.java | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/core/CoreService.java b/framework/src/onos/core/api/src/main/java/org/onosproject/core/CoreService.java new file mode 100644 index 00000000..3dfc6b26 --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/core/CoreService.java @@ -0,0 +1,83 @@ +/* + * Copyright 2014-2015 Open Networking Laboratory + * + * 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 org.onosproject.core; + +import org.onosproject.net.provider.ProviderId; + +import java.util.Set; + +/** + * Service for interacting with the core system of the controller. + */ +public interface CoreService { + + /** + * Name of the core "application". + */ + static final String CORE_APP_NAME = "org.onosproject.core"; + + /** + * Identifier of the core "provider". + */ + static final ProviderId CORE_PROVIDER_ID = new ProviderId("core", CORE_APP_NAME); + + /** + * Returns the product version. + * + * @return product version + */ + Version version(); + + /** + * Returns the set of currently registered application identifiers. + * + * @return set of application ids + */ + Set<ApplicationId> getAppIds(); + + /** + * Returns an existing application id from a given id. + * @param id the short value of the id + * @return an application id + */ + ApplicationId getAppId(Short id); + + /** + * Returns an existing application id from a given id. + * @param name the name portion of the ID to look up + * @return an application id + */ + ApplicationId getAppId(String name); + + /** + * Registers a new application by its name, which is expected + * to follow the reverse DNS convention, e.g. + * {@code org.flying.circus.app} + * + * @param identifier string identifier + * @return the application id + */ + ApplicationId registerApplication(String identifier); + + /** + * Returns an id generator for a given topic. + * + * @param topic topic identified + * @return the id generator + */ + IdGenerator getIdGenerator(String topic); + +} |