diff options
author | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
---|---|---|
committer | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/core/api/src/main/java/org/onosproject/app/ApplicationDescription.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/app/ApplicationDescription.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/app/ApplicationDescription.java | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/app/ApplicationDescription.java b/framework/src/onos/core/api/src/main/java/org/onosproject/app/ApplicationDescription.java new file mode 100644 index 00000000..2561280b --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/app/ApplicationDescription.java @@ -0,0 +1,89 @@ +/* + * Copyright 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.app; + +import org.onosproject.core.ApplicationRole; +import org.onosproject.core.Version; +import org.onosproject.security.Permission; + +import java.net.URI; +import java.util.List; +import java.util.Optional; +import java.util.Set; + +/** + * Description of a network control/management application. + */ +public interface ApplicationDescription { + + /** + * Returns the application name id. + * + * @return application identifier + */ + String name(); + + /** + * Returns the application version. + * + * @return application version + */ + Version version(); + + /** + * Returns description of the application. + * + * @return application description text + */ + String description(); + + /** + * Returns the name of the application origin, group or company. + * + * @return application origin + */ + String origin(); + + /** + * Returns the role of the application. + * + * @return application role + */ + ApplicationRole role(); + + /** + * Returns the permissions requested by the application. + * + * @return requested permissions + */ + Set<Permission> permissions(); + + /** + * Returns the feature repository URI. Null value signifies that the + * application did not provide its own features repository. + * + * @return optional feature repo URL + */ + Optional<URI> featuresRepo(); + + /** + * Returns the list of features comprising the application. At least one + * feature must be given. + * + * @return application features + */ + List<String> features(); +} |