001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 */ 019package org.apache.reef.driver.catalog; 020 021import org.apache.reef.annotations.Unstable; 022 023import java.util.Collection; 024 025/** 026 * A catalog of the resources available to a REEF instance. 027 * <p> 028 * This catalog contains static information about the resources and does not 029 * reflect that dynamic availability of resources. In other words: Its entries 030 * are an upper bound to what is available to a REEF Driver at any given 031 * moment in time. 032 */ 033@Unstable 034public interface ResourceCatalog { 035 036 /** 037 * The global list of resources. 038 * 039 * @return a list of all the static resources available. This is an upper 040 * bound. 041 */ 042 Collection<NodeDescriptor> getNodes(); 043 044 /** 045 * The global list of racks. 046 * 047 * @return list of all rack descriptors 048 */ 049 Collection<RackDescriptor> getRacks(); 050 051 /** 052 * Get the node descriptor with the given identifier. 053 * 054 * @param nodeId id of the node. 055 * @return the node descriptor assigned to the identifier. 056 */ 057 NodeDescriptor getNode(String nodeId); 058 059 /** 060 * Resource descriptor interface. 061 */ 062 interface Descriptor { 063 064 String getName(); 065 066 } 067 068}