org.ocap.hn.resource.NetResourceUsage Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ocap Show documentation

There is a newer version: 1.3.1

package org.ocap.hn.resource;

import org.dvb.application.AppID;
import org.ocap.resource.ResourceUsage;
import org.ocap.net.OcapLocator;
import java.net.InetAddress;
import java.util.Date;

/**
 * This interface represents a usage of resources on a specific home network
 * activity.
 */
public interface NetResourceUsage extends ResourceUsage
{
    /**
     * Usage type is presentation.
     */
    public final static String USAGE_TYPE_PRESENTATION = "Presentation";

    /**
     * Returns the network address of the device from which the request was
     * originated for this usage.
     * 
     * @return The network address of the device requesting resources.
     */
    public InetAddress getInetAddress();

    /**
     * Gets the usage type associated with this usage.
     * 
     * This method is intended to eventually report one of multiple
     * usage types; at present, it returns only
     * USAGE_TYPE_PRESENTATION.
     *
     * @return Returns USAGE_TYPE_PRESENTATION.
     */
    public String getUsageType();

    /**
     * Gets the OcapLocator of the service associated with this
     * usage.
     *
     * @return The OcapLocator.
     */
    public OcapLocator getOcapLocator();
    
    
    
    ///////// Methods inherited from ResourceUsage //////////
    
    /**
     * Returns null.
     *
     * @return null
     */
    public AppID getAppID();
}