incubator/api/src/main/java/org/onosproject/incubator/net/domain/IntentDomainConfig.java

/*
 * 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.incubator.net.domain;

import com.google.common.annotations.Beta;
import org.onosproject.incubator.net.config.Config;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DeviceId;

import java.util.Set;

/**
 * Configuration for an intent domain including a name, set of internal devices,
 * set of edge ports, and the application bound to control the domain.
 */
@Beta
public abstract class IntentDomainConfig extends Config<IntentDomainId> {

    private static final String DOMAIN_NAME = "domainName";
    private static final String APPLICATION_NAME = "applicationName";

    /**
     * Returns the friendly name for the domain.
     *
     * @return domain name
     */
    public String domainName() {
        return get(DOMAIN_NAME, subject.toString());
    }

    /**
     * Sets the friendly name for the domain.
     *
     * @param domainName new name for the domain; null to clear
     * @return self
     */
    public IntentDomainConfig domainName(String domainName) {
        return (IntentDomainConfig) setOrClear(DOMAIN_NAME, domainName);
    }

    /**
     * Returns the friendly name for the domain.
     *
     * @return domain name
     */
    public String applicationName() {
        return get(APPLICATION_NAME, null); //TODO maybe not null?
    }

    /**
     * Sets the friendly name for the domain.
     *
     * @param applicationName new name for the domain; null to clear
     * @return self
     */
    public IntentDomainConfig applicationName(String applicationName) {
        return (IntentDomainConfig) setOrClear(APPLICATION_NAME, applicationName);
    }

    //TODO sets
    abstract Set<DeviceId> internalDevices();
    abstract Set<ConnectPoint> edgePorts();

}