apps/dhcprelay/src/main/java/org/onosproject/dhcprelay/api/DhcpRelayService.java

/*
 * Copyright 2017-present Open Networking Foundation
 *
 * 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.dhcprelay.api;

import org.onlab.packet.IpPrefix;
import org.onlab.packet.MacAddress;
import org.onosproject.dhcprelay.store.DhcpRecord;
import org.onosproject.routing.fpm.api.FpmRecord;
import org.onosproject.net.HostId;
import java.util.Collection;
import java.util.List;
import java.util.Optional;

public interface DhcpRelayService {
    /**
     * Gets DHCP record for specific host id (mac + vlan).
     *
     * @param hostId the id of host
     * @return the DHCP record of the host
     */
    Optional<DhcpRecord> getDhcpRecord(HostId hostId);

    /**
     * Gets all DHCP records from store.
     *
     * @return all DHCP records from store
     */
    Collection<DhcpRecord> getDhcpRecords();

    /**
     * Updates DHCP record for specific host id (mac + vlan).
     *
     * @param hostId the id of host
     * @param dhcpRecord the DHCP record of the host
     */
    void updateDhcpRecord(HostId hostId, DhcpRecord dhcpRecord);

    /**
     * Gets mac address of DHCP server.
     *
     * @return the mac address of DHCP server; empty if not exist
     * @deprecated 1.12, use get DHCP server configs method
     */
    @Deprecated
    Optional<MacAddress> getDhcpServerMacAddress();

    /**
     * Gets list of default DHCP server information.
     *
     * @return list of default DHCP server information
     */
    List<DhcpServerInfo> getDefaultDhcpServerInfoList();

    /**
     * Gets list of indirect DHCP server information.
     *
     * @return list of indirect DHCP server information
     */
    List<DhcpServerInfo> getIndirectDhcpServerInfoList();

    /**
     * Add DHCP FPM record to store.
     *
     * @param prefix the prefix
     * @param fpmRecord the fpmRecord
     */
    void addFpmRecord(IpPrefix prefix, FpmRecord fpmRecord);

    /**
     * Delete DHCP FPM record from store.
     *
     * @param prefix the prefix
     * @return DHCP record from store; empty value if it does not exist.
     */
    Optional<FpmRecord> removeFpmRecord(IpPrefix prefix);

    /**
     * Gets PD route record for specific prefix.
     *
     * @param prefix PD prefix
     * @return the PD route record from store
     */
    Optional<FpmRecord> getFpmRecord(IpPrefix prefix);

    /**
     * Gets all PD route records from store.
     *
     * @return all PD records from store
     */
    Collection<FpmRecord> getFpmRecords();

    /**
     * Determine if DHCP FPM feature is enabled or not.
     *
     * @return boolean value
     */
    public boolean isDhcpFpmEnabled();

}