PersistenceAdapter.java

/*
 * Copyright 1999-2008 University of Chicago
 *
 * 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.globus.workspace.persistence;

import java.util.Calendar;
import java.util.Hashtable;
import java.util.List;

import org.globus.workspace.network.AssociationEntry;
import org.globus.workspace.scheduler.defaults.ResourcepoolEntry;
import org.globus.workspace.service.CoschedResource;
import org.globus.workspace.service.GroupResource;
import org.globus.workspace.service.InstanceResource;
import org.globus.workspace.service.binding.vm.FileCopyNeed;
import org.nimbustools.api.services.rm.DoesNotExistException;

/**
 * TODO: each module implementation needs to encapsulate its own persistence,
 *       the persistence package will go away entirely
 */
public interface PersistenceAdapter {

    public void setState(int id, int state, Throwable t)

            throws WorkspaceDatabaseException;

    public void setTargetState(int id, int targetState)

            throws WorkspaceDatabaseException;

    public void setOpsEnabled(int id, boolean enabled)

            throws WorkspaceDatabaseException;

    public void setNetwork(int id, String network)

            throws WorkspaceDatabaseException;

    public void setVMMaccessOK(int resourceID, boolean vmmAccessOK)

            throws WorkspaceDatabaseException;

    public void setHostname(int id, String hostname)

            throws WorkspaceDatabaseException;

    public void setRootUnpropTarget(int id, String path)

            throws WorkspaceDatabaseException;

    public void setFileCopyOnImage(int id, FileCopyNeed need)

            throws WorkspaceDatabaseException;

    public void setStartTime(int id, Calendar startTime)

            throws WorkspaceDatabaseException;

    public void setTerminationTime(int id, Calendar termTime)

            throws WorkspaceDatabaseException;

    public void remove(int id, InstanceResource resource)

            throws WorkspaceDatabaseException;

    public void removeGroup(String id)

            throws WorkspaceDatabaseException;

    public void removeEnsemble(String id)

            throws WorkspaceDatabaseException;

    public int[] findActiveWorkspacesIDs()

            throws WorkspaceDatabaseException;

    public boolean isActiveWorkspaceID(int id)

            throws WorkspaceDatabaseException;

    public int[] findVMsInGroup(String groupID)

            throws WorkspaceDatabaseException;

    public int[] findVMsInEnsemble(String ensembleID)

            throws WorkspaceDatabaseException;

    public int[] findVMsByOwner(String ownerID)

            throws WorkspaceDatabaseException;

    public void add(InstanceResource resource)

            throws WorkspaceDatabaseException;

    public void addGroup(GroupResource resource)

            throws WorkspaceDatabaseException;

    public void addEnsemble(CoschedResource resource)

            throws WorkspaceDatabaseException;

    public void load(int id, InstanceResource resource)

            throws DoesNotExistException,
                   WorkspaceDatabaseException;

    public void loadGroup(String id, GroupResource resource)

            throws DoesNotExistException,
                   WorkspaceDatabaseException;

    public void loadEnsemble(String id, CoschedResource resource)

            throws DoesNotExistException,
                   WorkspaceDatabaseException;

    public void replaceAssocations(Hashtable associations)

            throws WorkspaceDatabaseException;

    public void replaceAssociationEntry(String name,
                                        AssociationEntry entry)

            throws WorkspaceDatabaseException;

    public Hashtable currentAssociations()

            throws WorkspaceDatabaseException;

    public Hashtable currentAssociations(boolean cachedIsFine)

            throws WorkspaceDatabaseException;

    public void updateResourcepoolEntryAvailableMemory(String hostname, int newAvailMemory)

            throws WorkspaceDatabaseException;

    public int memoryUsedOnPoolnode(String poolnode)

            throws WorkspaceDatabaseException;

    public List<ResourcepoolEntry> currentResourcepoolEntries() throws WorkspaceDatabaseException;

    public ResourcepoolEntry getResourcepoolEntry(String hostname)

            throws WorkspaceDatabaseException;

    public void addResourcepoolEntry(ResourcepoolEntry entry)

            throws WorkspaceDatabaseException;

    public boolean removeResourcepoolEntry(String hostname)

            throws WorkspaceDatabaseException;

    public void addCustomizationNeed(int id, FileCopyNeed need)

            throws WorkspaceDatabaseException;

    public int readPropagationCounter()

            throws WorkspaceDatabaseException;

    public long currentCursorPosition()

            throws WorkspaceDatabaseException;

    public void updatePropagationCounter(int n)

            throws WorkspaceDatabaseException;

    public void updateCursorPosition(long currentPosition)

            throws WorkspaceDatabaseException;
    
    //SQL processing
    
    public List<ResourcepoolEntry> getAvailableEntriesSortedByFreeMemoryPercentage(int requestedMem) 
    
            throws WorkspaceDatabaseException;

    boolean updateResourcepoolEntry(String hostname,
                                        String pool,
                                        String networks,
                                        Integer memoryMax,
                                        Integer memoryAvail,
                                        Boolean active)
            throws WorkspaceDatabaseException;
}