org.snmp4j.agent.DefaultMOServer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snmp4j-agent Show documentation
SNMP-Agent API for Java
There is a newer version: 3.8.2
/*_############################################################################
  _## 
  _##  SNMP4J-Agent 2 - DefaultMOServer.java  
  _## 
  _##  Copyright (C) 2005-2014  Frank Fock (SNMP4J.org)
  _##  
  _##  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.snmp4j.agent;

import java.util.*;
import java.util.Map.Entry;

import org.snmp4j.agent.mo.*;
import org.snmp4j.agent.mo.lock.DefaultMOLockStrategy;
import org.snmp4j.agent.mo.lock.LockRequest;
import org.snmp4j.agent.mo.lock.MOLockStrategy;
import org.snmp4j.log.*;
import org.snmp4j.mp.SnmpConstants;
import org.snmp4j.smi.*;

/**
 * The default MO server implementation uses a sorted map for the managed object
 * registry.
 *
 * @author Frank Fock
 * @version 2.4.0
 */
public class DefaultMOServer implements MOServer {

  private static final LogAdapter logger =
      LogFactory.getLogger(DefaultMOServer.class);

  private Set contexts;
  private SortedMap registry;
  private Map lockList;
  private Map> lookupListener;
  private transient Vector contextListeners;
  private UpdateStrategy updateStrategy;
  private MOLockStrategy lockStrategy = new DefaultMOLockStrategy();


  public DefaultMOServer() {
    this.registry = new TreeMap(new MOScopeComparator());
        //Collections.synchronizedSortedMap(new TreeMap(new MOScopeComparator()));
    this.contexts = new LinkedHashSet(10);
    this.lockList = new Hashtable(10);
  }


  @Override
  public ManagedObject lookup(MOQuery query) {
    return lookup(query, false, null);
  }

  @Override
  public ManagedObject lookup(MOQuery query, LockRequest lockRequest) {
    return lookup(query, false, lockRequest);
  }


  /**
   * Return the locking strategy for this server. The strategy defines if a lock is acquired before
   * a looked up {@link ManagedObject} is returned (and before the corresponding lookup event is being fired) or not.
   * @return
   *    the managed object locking strategy instance used by this server. If null, no locking is performed
   *    at all (which is only recommended for static content servers).
   * @since 2.4.0
   */
  public MOLockStrategy getLockStrategy() {
    return lockStrategy;
  }

  /**
   * Sets the lock strategy for this server. The strategy defines if a lock is acquired before
   * a looked up {@link ManagedObject} is returned (and before the corresponding lookup event is being fired) or not.
   * By default, only write access needs a lock.
   * @param lockStrategy
   *    a {@link MOLockStrategy} instance or null to suppress any locking.
   * @since 2.4.0
   */
  public void setLockStrategy(MOLockStrategy lockStrategy) {
    this.lockStrategy = lockStrategy;
  }

  private ManagedObject lookup(MOQuery query, boolean specificRegistrationsOnly, LockRequest lockRequest) {

    SortedMap scope = registry.tailMap(query);
    boolean timedOut = false;
    if (lockRequest != null) {
      lockRequest.setLockRequestStatus(LockRequest.LockStatus.notRequired);
    }
    for (Entry entry : scope.entrySet()) {
      MOScope key = entry.getKey();
      if (!MOScopeComparator.isQueryContextMatching(query, key)) {
        continue;
      }
      if ((specificRegistrationsOnly) && (((key instanceof MOContextScope) &&
          (((MOContextScope) key).getContext() == null)) ||
          !(key instanceof MOContextScope))) {
        continue;
      }
      ManagedObject mo = entry.getValue();
      MOScope moScope = mo.getScope();
      if (query.getScope().isOverlapping(moScope)) {
        fireQueryEvent(mo, query);
        // apply locking if needed
        if ((lockStrategy != null) && (lockRequest != null) && (lockRequest.getLockOwner() != null) &&
            lockStrategy.isLockNeeded(mo, query)) {
          if (!lock(lockRequest.getLockOwner(), mo, lockRequest.getTimeoutMillis())) {
            timedOut = true;
            continue;
          }
          else {
            lockRequest.setLockRequestStatus((timedOut)?
                LockRequest.LockStatus.lockedAfterTimeout : LockRequest.LockStatus.locked);
          }
        }
        if (mo instanceof UpdatableManagedObject) {
          checkForUpdate((UpdatableManagedObject) mo, query);
        }
        if (query.matchesQuery(mo)) {
          fireLookupEvent(mo, query);
          return mo;
        }
        else if (lockRequest != null) {
          unlock(lockRequest.getLockOwner(), mo);
        }
      }
    }
    if (timedOut) {
      lockRequest.setLockRequestStatus(LockRequest.LockStatus.lockTimedOut);
    }
    return null;
  }

  /**
   * Checks {@link #updateStrategy} whether the queried managed object needs
   * to be updated. This method is called on behalf of
   * {@link #lookup(MOQuery query)} after {@link #fireQueryEvent} and before
   * {@link #fireLookupEvent} is being called.
   *
   * @param mo
   *    an UpdatableManagedObject instance.
   * @param query
   *    the query that is interested in content of mo.
   * @since 1.2
   */
  protected void checkForUpdate(UpdatableManagedObject mo, MOQuery query) {
    if (updateStrategy != null) {
      if (updateStrategy.isUpdateNeeded(this, mo, query)) {
        if (logger.isDebugEnabled()) {
          logger.debug("Updating UpdatableManagedObject "+mo+
                       " on behalf of query "+query);
        }
        mo.update(query);
      }
    }
  }

  /**
   * Returns the ManagedObject with the specified OID
   * as ID returned by {@link RegisteredManagedObject#getID()} or the lower bound
   * (regardless whether the ManagedObject's scope includes it or not)
   * when registered in the supplied context.
   * 
   * Note: The query used to lookup the managed object will indicate an intended
   * read-only access for the {@link MOServerLookupEvent}s fired on behalf of
   * this method.
   * @param key
   *    the OID identifying the key (lower bound) of the
   *    ManagedObject.
   * @param context
   *    the optional context to look in. A null value searches
   *    in all contexts.
   * @param fireLookupEvents
   *    if true lookup and query events will be fired as if the managed
   *    objects has been looked up by {@link #lookup(MOQuery)}. In addition, if
   *    the looked up managed object is an {@link UpdatableManagedObject} it will be locked
   *    if the lock strategy of this server requires it. The lock is active until the look up
   *    events have been fired completely. The lock operation waits without timeout for the lock
   *    to become available.
   *    Otherwise, no events will be fired at all.
   * @return
   *    the ManagedObject instance or null if such
   *    an instance does not exists.
   * @since 2.3
   */
  public ManagedObject getManagedObject(OID key, OctetString context, boolean fireLookupEvents) {
    MOContextScope scope =
        new DefaultMOContextScope(context, key, true, key, true);
    MOQuery query = new DefaultMOQuery(scope);
    SortedMap reducedScope = registry.tailMap(query);
    for (Entry entry : reducedScope.entrySet()) {
      MOScope compareScope = entry.getKey();
      if (!MOScopeComparator.isQueryContextMatching(query, compareScope)) {
        continue;
      }
      ManagedObject mo = entry.getValue();
      if (((mo instanceof RegisteredManagedObject) && ((RegisteredManagedObject)mo).getID().equals(key)) ||
          (!(mo instanceof RegisteredManagedObject) && key.equals(mo.getScope().getLowerBound())))  {
        if (fireLookupEvents) {
          fireQueryEvent(mo, query);
          boolean locked = false;
          if (mo instanceof UpdatableManagedObject) {
            locked = lock(this, mo);
            if (locked) {
              checkForUpdate((UpdatableManagedObject) mo, query);
            }
          }
          fireLookupEvent(mo, query);
          if (locked) {
            unlock(this, mo);
          }
        }
        return mo;
      }
    }
    return null;
  }

    /**
     * Returns the ManagedObject with the specified OID
     * as ID returned by {@link RegisteredManagedObject#getID()} or the lower bound
     * (regardless whether the ManagedObject's scope includes it or not)
     * when registered in the supplied context.
     * 
     * Note: The query used to lookup the managed object will indicate an intended
     * read-only access for the {@link MOServerLookupEvent}s fired on behalf of
     * this method.
     * @param key
     *    the OID identifying the key (lower bound) of the
     *    ManagedObject.
     * @param context
     *    the optional context to look in. A null value searches
     *    in all contexts.
     * @return
     *    the ManagedObject instance or null if such
     *    an instance does not exists.
     * @since 1.1
     */
  public ManagedObject getManagedObject(OID key, OctetString context) {
    return getManagedObject(key, context, true);
  }

  /**
   * Returns the value of a particular MIB object instance using the
   * {@link ManagedObjectValueAccess} interface. If a {@link ManagedObject}
   * does not support this interface, its value cannot be returned and
   * null will be returned instead.
   * Note: This method does not perform any locking based on the {@link MOLockStrategy}.
   * @param server
   *    the MOServer where to lookup the value.
   * @param context
   *    the optional context to look in. A null value searches
   *    in all contexts.
   * @param key
   *    the OID identifying the variable instance to return.
   * @return
   *    the Variable associated with OID and
   *    context in server or null if
   *    no such variable exists.
   * @since 1.4
   */
  public static Variable getValue(MOServer server, OctetString context,
                                  OID key) {

    MOContextScope scope =
        new DefaultMOContextScope(context, key, true, key, true);
    ManagedObject mo = server.lookup(new DefaultMOQuery(scope));
    if (mo instanceof ManagedObjectValueAccess) {
      return ((ManagedObjectValueAccess)mo).getValue(key);
    }
    return null;
  }

  /**
   * Sets the value of a particular MIB object instance using the
   * {@link ManagedObjectValueAccess} interface. If a {@link ManagedObject}
   * does not support this interface, its value cannot be set and
   * false will be returned.
   * Note: This method does not perform any locking based on the {@link MOLockStrategy}.
   *
   * @param server
   *    the MOServer where to lookup the value.
   * @param context
   *    the optional context to look in. A null value searches
   *    in all contexts.
   * @param newValueAndKey
   *    the OID identifying the variable instance to set and its new value.
   * @return
   *    the true if the value has been set successfully,
   *    false otherwise.
   * @since 1.4
   */
  public static boolean setValue(MOServer server, OctetString context,
                                 VariableBinding newValueAndKey) {
    OID key = newValueAndKey.getOid();
    MOContextScope scope =
        new DefaultMOContextScope(context, key, true, key, true);
    ManagedObject mo = server.lookup(new DefaultMOQuery(scope));
    if (mo instanceof ManagedObjectValueAccess) {
      return ((ManagedObjectValueAccess)mo).setValue(newValueAndKey);
    }
    return false;
  }

  protected void fireLookupEvent(ManagedObject mo, MOQuery query) {
    if (lookupListener != null) {
      List l = lookupListener.get(mo);
      if (l != null) {
        MOServerLookupEvent event = new MOServerLookupEvent(this, mo, query);
        // avoid concurrent modification exception
        l = new ArrayList(l);
        for (MOServerLookupListener item : l) {
          item.lookupEvent(event);
        }
      }
    }
  }

  protected void fireQueryEvent(ManagedObject mo, MOQuery query) {
    if (lookupListener != null) {
      List l = lookupListener.get(mo);
      if (l != null) {
        MOServerLookupEvent event = new MOServerLookupEvent(this, mo, query);
        // avoid concurrent modification exception
        l = new ArrayList(l);
        for (MOServerLookupListener item : l) {
          item.queryEvent(event);
        }
      }
    }
  }

  public OctetString[] getContexts() {
    return contexts.toArray(new OctetString[contexts.size()]);
  }

  public boolean isContextSupported(OctetString context) {
    if ((context == null) || (context.length() == 0)) {
      return true;
    }
    return contexts.contains(context);
  }

  public SortedMap getRegistry() {
    return registry;
  }

  /**
   * Gets the update strategy for {@link UpdatableManagedObject}s. If the
   * strategy is null no updates will be performed on behalf
   * of calls to {@link #lookup}.
   *
   * @return
   *    the current UpdateStrategy instance or null if no
   *    strategy is active.
   * @since 1.2
   * @see #lookup
   */
  public UpdateStrategy getUpdateStrategy() {
    return updateStrategy;
  }

  /**
   * Sets the update strategy for {@link UpdatableManagedObject}s. If the
   * strategy is null no updates will be performed on behalf
   * of calls to {@link #lookup(MOQuery)}.
   *
   * @param updateStrategy
   *    the new UpdateStrategy instance or null if no
   *    updates should be performed.
   * @since 1.2
   * @see #lookup(MOQuery)
   */
  public void setUpdateStrategy(UpdateStrategy updateStrategy) {
    this.updateStrategy = updateStrategy;
  }

  @Override
  public void register(ManagedObject mo, OctetString context)
      throws DuplicateRegistrationException
  {
    if ((context == null) || (context.length() == 0)) {
      MOContextScope contextScope =
          new DefaultMOContextScope(null, mo.getScope());
      ManagedObject other = lookup(new DefaultMOQuery(contextScope));
      if (other != null) {
        throw new DuplicateRegistrationException(contextScope,
                                                 other.getScope());
      }
      registry.put(mo.getScope(), mo);
      if (logger.isInfoEnabled()) {
        logger.info("Registered MO ["+mo.getClass().getSimpleName()+"] in default context with scope "+
                     mo.getScope());
      }
    }
    else {
      DefaultMOContextScope contextScope =
          new DefaultMOContextScope(context, mo.getScope());
      ManagedObject other = lookup(new DefaultMOQuery(contextScope), true, null);
      if (other != null) {
        throw new DuplicateRegistrationException(contextScope, other.getScope());
      }
      registry.put(contextScope, mo);
      if (logger.isInfoEnabled()) {
        logger.info("Registered MO ["+mo.getClass().getSimpleName()+"] in context "+context+" with scope "+
                     contextScope);
      }
    }
  }

  @Override
  public ManagedObject unregister(ManagedObject mo, OctetString context) {
    MOScope key;
    if ((context == null) || (context.length() == 0)) {
      key = mo.getScope();
    }
    else {
      key = new DefaultMOContextScope(context, mo.getScope());
    }
    ManagedObject r = registry.remove(key);
    if (r == null) {
      // OK, may be the upper bound of the scope has been adjusted so we need to
      // check that by iterating
      SortedMap tailMap = registry.tailMap(key);
      for (Iterator> it = tailMap.entrySet().iterator(); it.hasNext();) {
        Entry entry = it.next();
        MOScope entryKey = entry.getKey();
        if ((entry.getValue().equals(mo)) &&
            (((context != null) &&
              (entryKey instanceof MOContextScope) &&
              (context.equals(((MOContextScope)entryKey).getContext()))) ||
             (context == null))) {
          r = entry.getValue();
          it.remove();
          break;
        }
      }
    }
    if (logger.isInfoEnabled()) {
      if (r != null) {
        logger.info("Removed registration " + r + " for " + mo.getScope() +
                    " in context '" + context + "' successfully");
      }
      else {
        logger.warn("Removing registration failed for " + mo.getScope() +
                    " in context '" + context + "'");
      }
    }
    return r;
  }

  public void addContext(OctetString context) {
    contexts.add(context);
  }

  public void removeContext(OctetString context) {
    contexts.remove(context);
  }

  public synchronized boolean lock(Object owner, ManagedObject managedObject) {
    return lock(owner, managedObject, 0);
  }

  public synchronized boolean lock(Object owner, ManagedObject managedObject,
                                   long timeoutMillis) {
    Lock lock;
    long start = System.nanoTime();
    do {
      lock = lockList.get(managedObject);
      if ((lock == null) || ((lock.getOwner() != owner) && (lock.getCount() <= 0))) {
        lockList.put(managedObject, new Lock(owner));
        if (logger.isDebugEnabled()) {
          logger.debug("Acquired lock on "+managedObject+ " for "+owner);
        }
        return true;
      }
      else if (lock.getOwner() != owner) {
        try {
          while ((lock.getCount() > 0) &&
                 ((System.nanoTime() - start) / SnmpConstants.MILLISECOND_TO_NANOSECOND < timeoutMillis)) {
            if (logger.isDebugEnabled()) {
              logger.debug("Waiting for lock on " + managedObject);
            }
            if (timeoutMillis <= 0) {
              wait();
            }
            else {
              wait(Math.max(timeoutMillis -
                            (System.nanoTime() - start) / SnmpConstants.MILLISECOND_TO_NANOSECOND, 1));
            }
          }
        }
        catch (InterruptedException ex) {
          logger.warn("Waiting for lock on "+managedObject+
                      " has been interrupted!");
          break;
        }
      }
      else {
        lock.add();
        if (logger.isDebugEnabled()) {
          logger.debug("Added lock on "+managedObject+ " for "+owner);
        }
        return true;
      }
    }
    while (((timeoutMillis <= 0) ||
            ((System.nanoTime() - start) / SnmpConstants.MILLISECOND_TO_NANOSECOND < timeoutMillis)));
    return false;
  }

  public synchronized boolean unlock(Object owner, ManagedObject managedObject) {
    if (managedObject != null) {
      Lock lock = lockList.get(managedObject);
      if (lock != null) {
        if (lock.getOwner() != owner) {
          if (logger.isDebugEnabled()) {
            logger.debug("Object '" + owner + "' is not owner of lock: " + lock);
          }
        }
        else if (lock.remove()) {
          lockList.remove(managedObject);
          if (logger.isDebugEnabled()) {
            logger.debug("Removed lock on " + managedObject + " by " + owner);
          }
          notify();
          return true;
        }
      }
    }
    return false;
  }

  public Iterator> iterator() {
    SortedMap m = getRegistry();
    synchronized (m) {
      SortedMap r = new TreeMap(new MOScopeComparator());
      r.putAll(m);
      return r.entrySet().iterator();
    }
  }

  public synchronized void addLookupListener(MOServerLookupListener listener,
                                             ManagedObject mo) {
    if (lookupListener == null) {
      lookupListener = Collections.synchronizedMap(new HashMap>());
    }
    List l = lookupListener.get(mo);
    if (l == null) {
      l = Collections.synchronizedList(new LinkedList());
      lookupListener.put(mo, l);
    }
    l.add(listener);
  }

  public synchronized boolean removeLookupListener(MOServerLookupListener listener,
      ManagedObject mo)
  {
    if (lookupListener != null) {
      List l = lookupListener.get(mo);
      if (l != null) {
        return l.remove(listener);
      }
    }
    return false;
  }

  public synchronized void addContextListener(ContextListener l) {
    if (contextListeners == null) {
      contextListeners = new Vector(2);
    }
    contextListeners.add(l);
  }

  public synchronized void removeContextListener(ContextListener l) {
    if (contextListeners != null) {
      contextListeners.remove(l);
    }
  }

  protected void fireContextChanged(ContextEvent event) {
    if (contextListeners != null) {
      Vector listeners = contextListeners;
      for (ContextListener listener : listeners) {
        listener.contextChanged(event);
      }
    }
  }

  public String toString() {
    StringBuffer buf = new StringBuffer(getClass().getName());
    buf.append("[contexts=");
    buf.append(contexts);
    buf.append("[keys={");
    for (Iterator it = registry.keySet().iterator(); it.hasNext();) {
      MOScope scope = it.next();
      buf.append(scope.getLowerBound());
      if (scope.isLowerIncluded()) {
        buf.append("+");
      }
      buf.append("-");
      buf.append(scope.getUpperBound());
      if (scope.isUpperIncluded()) {
        buf.append("+");
      }
      if (scope instanceof MOContextScope) {
        buf.append("(").append(((MOContextScope) scope).getContext()).append(")");
      }
      if (it.hasNext()) {
        buf.append(",");
      }
    }
    buf.append("}");
    buf.append(",registry=").append(registry);
    buf.append(",lockList=").append(lockList);
    buf.append(",lookupListener=").append(lookupListener);
    buf.append("]");
    return buf.toString();
  }

  @Override
  public OctetString[] getRegisteredContexts(ManagedObject managedObject) {
    Set contextSet = new HashSet();
    SortedMap scope = registry.tailMap(new DefaultMOContextScope(null,
        managedObject.getScope()));
    for (Entry entry : scope.entrySet()) {
      MOScope key = entry.getKey();
      ManagedObject o = entry.getValue();
      if (managedObject.equals(o)) {
        if (key instanceof MOContextScope) {
          contextSet.add(((MOContextScope)key).getContext());
        }
        else {
          contextSet.add(null);
        }
      }
    }
    return contextSet.toArray(new OctetString[contextSet.size()]);
  }

  /**
   * Register a single {@link MOTableRowListener} with all tables in the
   * specified {@link MOServer}. This overall registration can be used,
   * for example, to apply table size limits to all tables in an agent.
   * See {@link org.snmp4j.agent.mo.util.MOTableSizeLimit} for details.
   * 

   * Note: The server must not change its registration content while this
   * method is being called, otherwise a
   * {@link java.util.ConcurrentModificationException} might be thrown.
   *
   * @param server
   *    a MOServer instance.
   * @param listener
   *    the MOTableRowListener instance to register.
   * @since 1.4
   */
  @SuppressWarnings("unchecked")
  public static >>
      void registerTableRowListener(MOServer server, MOTableRowListener listener) {
    for (Iterator> it = server.iterator(); it.hasNext(); ) {
      ManagedObject mo = it.next().getValue();
      if (mo instanceof MOTable) {
        ((T)mo).addMOTableRowListener(listener);
      }
    }
  }

  /**
   * Unregister a single {@link MOTableRowListener} with all tables in the
   * specified {@link MOServer}. This overall unregistration can be used,
   * for example, to remove table size limits from all tables in an agent.
   * See {@link org.snmp4j.agent.mo.util.MOTableSizeLimit} for details.
   * 

   * Note: The server must not change its registration content while this
   * method is being called, otherwise a
   * {@link java.util.ConcurrentModificationException} might be thrown.
   *
   * @param server
   *    a MOServer instance.
   * @param listener
   *    the MOTableRowListener instance to unregister.
   * @since 1.4
   */
  @SuppressWarnings("unchecked")
  public static >>
      void unregisterTableRowListener(MOServer server, MOTableRowListener listener) {
    for (Iterator> it = server.iterator(); it.hasNext(); ) {
      ManagedObject mo = it.next().getValue();
      if (mo instanceof MOTable) {
        ((T)mo).removeMOTableRowListener(listener);
      }
    }
  }

  static class Lock {
    private Object owner;
    private long creationTime;
    private int count = 0;

    private Lock() {
      this.creationTime = System.currentTimeMillis();
      this.count = 0;
    }

    Lock(Object owner) {
      this();
      this.owner = owner;
      this.count = 1;
    }

    public long getCreationTime() {
      return creationTime;
    }

    public int getCount() {
      return count;
    }

    public synchronized void add() {
      count++;
    }

    public synchronized boolean remove() {
      if ((--count) <= 0) {
        if (count != 0) {
          count = 0;
        }
        return true;
      }
      return false;
    }

    public Object getOwner() {
      return owner;
    }

    @Override
    public String toString() {
      return "Lock[" +
          "owner=" + owner +
          ", creationTime=" + creationTime +
          ", count=" + count +
          ']';
    }
  }

}