Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2000-2011 Regents of the University of California and the

 *              National Center for Ecological Analysis and Synthesis

 *

 *   '$Author$'

 *     '$Date$'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.dataone;

import java.io.InputStream;

import java.util.Date;

import org.dataone.service.exceptions.InvalidRequest;

import org.dataone.service.exceptions.InvalidToken;

import org.dataone.service.exceptions.NotAuthorized;

import org.dataone.service.exceptions.NotFound;

import org.dataone.service.exceptions.NotImplemented;

import org.dataone.service.exceptions.ServiceFailure;

import org.dataone.service.types.AccessPolicy;

import org.dataone.service.types.Checksum;

import org.dataone.service.types.Event;

import org.dataone.service.types.Identifier;

import org.dataone.service.types.Log;

import org.dataone.service.types.Permission;

import org.dataone.service.types.Session;

import org.dataone.service.types.SystemMetadata;

public abstract class D1NodeService {

	/* Methods common to CNCore and MNCore APIs */

	/**

	 * Return the log records associated with a given event between the start and 

	 * end dates listed given a particular Subject listed in the Session

	 * 

	 * @param session - the Session object containing the credentials for the Subject

	 * @param fromDate - the start date of the desired log records

	 * @param toDate - the end date of the desired log records

	 * 

	 * @return the desired log records

	 * 

	 * @throws InvalidToken

	 * @throws ServiceFailure

	 * @throws NotAuthorized

	 * @throws InvalidRequest

	 * @throws NotImplemented

	 */

	public Log getLogRecords(Session session, Date fromDate, Date toDate, 

      Event event) throws InvalidToken, ServiceFailure,

	    NotAuthorized, InvalidRequest, NotImplemented {

		return null;

	}

	/* End methods common to CNCore and MNCore APIs */

	/* Methods common to CNRead and MNRead APIs */

	/**

	 * Return the object identified by the given object identifier

	 * 

	 * @param session - the Session object containing the credentials for the Subject

	 * @param pid - the object identifier for the given object

	 * 

	 * @return inputStream - the input stream of the given object

	 * 

	 * @throws InvalidToken

	 * @throws ServiceFailure

	 * @throws NotAuthorized

	 * @throws InvalidRequest

	 * @throws NotImplemented

	 */

	public InputStream get(Session session, Identifier pid) 

	  throws InvalidToken, ServiceFailure, NotAuthorized, NotFound, 

	  NotImplemented, InvalidRequest {

		return null;

	}

	/**

	 * Return the system metadata for a given object

	 * 

	 * @param session - the Session object containing the credentials for the Subject

	 * @param pid - the object identifier for the given object

	 * 

	 * @return inputStream - the input stream of the given system metadata object

	 * 

	 * @throws InvalidToken

	 * @throws ServiceFailure

	 * @throws NotAuthorized

	 * @throws NotFound

	 * @throws InvalidRequest

	 * @throws NotImplemented

	 */

	public SystemMetadata getSystemMetadata(Session session, Identifier pid)

    throws InvalidToken, ServiceFailure, NotAuthorized, NotFound,

    InvalidRequest, NotImplemented {

		return null;

  }

	/**

	 * Return a checksum of the object given the object identifier and the name

	 * of the checksum algorithm (the default being SHA-1)

	 * 

	 * @param session - the Session object containing the credentials for the Subject

	 * @param pid - the object identifier for the given object

	 * @param algorithm - the name of the checksum algorithm to be used

	 * @return

	 * @throws InvalidToken

	 * @throws ServiceFailure

	 * @throws NotAuthorized

	 * @throws NotFound

	 * @throws InvalidRequest

	 * @throws NotImplemented

	 */

	/* TODO: CNRead and MNRead have different getChecksum() signatures. Reconcile this first.

	public Checksum getChecksum(Session session, Identifier pid, String algorithm)

    throws InvalidToken, ServiceFailure, NotAuthorized, NotFound,

    InvalidRequest, NotImplemented {

		return null;

  }

  */

	/* End methods common to CNRead and MNRead APIs */

	/* Methods common to CNAuthorization and MNAuthorization APIs */

	/**

   * Determine if a particular operation can be performed on an object given

   * by the Subject identified in the Session.

   * 	 

   * @param session - the Session object containing the credentials for the Subject

	 * @param pid - the object identifier for the given object to determine authorization

	 * @param operation - the permission to check for authorization

	 * 

   * @return true or false

	 * @throws InvalidToken

	 * @throws ServiceFailure

	 * @throws NotFound

	 * @throws NotAuthorized

	 * @throws NotImplemented

	 * @throws InvalidRequest

   */

	public boolean isAuthorized(Session session, Identifier pid, Permission operation)

	  throws ServiceFailure, InvalidRequest, InvalidToken, NotFound,

	  NotAuthorized, NotImplemented {

		return false;

	}

	/**

	 * Set access for a given object using the object identifier and a Subject

	 * under a given Session.

	 * 

	 * @param session - the Session object containing the credentials for the Subject

	 * @param pid - the object identifier for the given object to apply the policy

	 * @param policy - the access policy to be applied

	 * 

	 * @return true or false

	 * @throws InvalidToken

	 * @throws ServiceFailure

	 * @throws NotFound

	 * @throws NotAuthorized

	 * @throws NotImplemented

	 * @throws InvalidRequest

	 */

	public boolean setAccessPolicy(Session session, Identifier pid, 

    AccessPolicy policy) 

	  throws InvalidToken, ServiceFailure, NotFound, NotAuthorized, 

	  NotImplemented, InvalidRequest {

		return false;

	}

	/* End methods common to CNAuthorization and MNAuthorization APIs */

}