AgentStateUpdate.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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.opencastproject.capture.admin.api;

import org.opencastproject.util.HashtableAdapter;

import java.util.Properties;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

/**
 * A representation of an agent which stores its name, state and time-since-last-update value.
 */
@XmlType(name = "agent-state-update", namespace = "http://capture.admin.opencastproject.org")
@XmlRootElement(name = "agent-state-update", namespace = "http://capture.admin.opencastproject.org")
@XmlAccessorType(XmlAccessType.FIELD)
public class AgentStateUpdate {

  /**
   * The agent's name.
   */
  @XmlElement(name = "name")
  private String name;

  /**
   * The state of the agent. This should be defined from the constants in
   * {@link org.opencastproject.capture.admin.api.AgentState}.
   *
   * @see AgentState
   */
  @XmlElement(name = "state")
  private String state;

  /**
   * The agent's URL.
   */
  @XmlElement(name = "url")
  private String url;

  /**
   * The number of milliseconds since the last time the agent checked in. Note that this is relative (ie, it's been 3000
   * ms) rather than absolute (milliseconds since 1970).
   */
  @XmlElement(name = "time-since-last-update")
  private Long timeSinceLastUpdate;

  @XmlJavaTypeAdapter(HashtableAdapter.class)
  private Properties capabilities;

  /**
   * Required zero-arg. constructor. Do not use.
   */
  public AgentStateUpdate() {
  }

  /**
   * Builds an AgentStateUpdate object about the Agent a. This calculates the time delta for you.
   *
   * @param a
   *          The agent you wish to know more information about.
   */
  public AgentStateUpdate(Agent a) {
    name = a.getName();
    state = a.getState();
    url = a.getUrl();
    capabilities = a.getCapabilities();
    timeSinceLastUpdate = System.currentTimeMillis() - a.getLastHeardFrom();
  }

  /**
   * Returns the agent name.
   *
   * @return the name
   */
  public String getName() {
    return name;
  }

  /**
   * Returns the agent url.
   *
   * @return the url
   */
  public String getUrl() {
    return url;
  }

  /**
   * Returns the agent state.
   *
   * @return the state
   */
  public String getState() {
    return state;
  }

  /**
   * Returns the agent capabilities.
   *
   * @return the capabilities
   */
  public Properties getCapabilities() {
    return capabilities;
  }

  /**
   * Returns the time when the agent was last seen online.
   *
   * @return the time of the last update
   */
  public Long getTimeSinceLastUpdate() {
    return timeSinceLastUpdate;
  }

}