org.apache.brooklyn.camp.spi.AssemblyTemplate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camp-base Show documentation
Core base classes for CAMP server implementation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.brooklyn.camp.spi;

import org.apache.brooklyn.camp.spi.collection.BasicResourceLookup;
import org.apache.brooklyn.camp.spi.collection.ResourceLookup;
import org.apache.brooklyn.camp.spi.collection.ResourceLookup.EmptyResourceLookup;
import org.apache.brooklyn.camp.spi.instantiate.AssemblyTemplateInstantiator;

import com.google.common.base.Preconditions;


/** Holds the metadata (name, description, etc) for an AssemblyTemplate
 * as well as fields pointing to behaviour (eg list of ACT's).
 * 
 * See {@link AbstractResource} for more general information.
 */
public class AssemblyTemplate extends AbstractResource {

    public static final String CAMP_TYPE = "AssemblyTemplate";
    static { assert CAMP_TYPE.equals(AssemblyTemplate.class.getSimpleName()); }
    
    Class instantiator;
    ResourceLookup applicationComponentTemplates;
    ResourceLookup platformComponentTemplates;
    
    // TODO
//    "parameterDefinitionUri": URI,
//    "pdpUri" : URI ?
                    
    /** Use {@link #builder()} to create */
    protected AssemblyTemplate() {}

    public Class getInstantiator() {
        return instantiator;
    }
    public ResourceLookup getApplicationComponentTemplates() {
        return applicationComponentTemplates != null ? applicationComponentTemplates : new EmptyResourceLookup();
    }
    public ResourceLookup getPlatformComponentTemplates() {
        return platformComponentTemplates != null ? platformComponentTemplates : new EmptyResourceLookup();
    }
    
    private void setInstantiator(Class instantiator) {
        this.instantiator = instantiator;
    }
    private void setApplicationComponentTemplates(ResourceLookup applicationComponentTemplates) {
        this.applicationComponentTemplates = applicationComponentTemplates;
    }
    private void setPlatformComponentTemplates(ResourceLookup platformComponentTemplates) {
        this.platformComponentTemplates = platformComponentTemplates;
    }
    
    // builder
    
    public static Builder builder() {
        return new AssemblyTemplate().new Builder(CAMP_TYPE);
    }
    
    public class Builder extends AbstractResource.Builder> {
        
        protected Builder(String type) { super(type); }
        
        public Builder instantiator(Class x) { AssemblyTemplate.this.setInstantiator(x); return thisBuilder(); }
        public Builder applicationComponentTemplates(ResourceLookup x) { AssemblyTemplate.this.setApplicationComponentTemplates(x); return thisBuilder(); }
        public Builder platformComponentTemplates(ResourceLookup x) { AssemblyTemplate.this.setPlatformComponentTemplates(x); return thisBuilder(); }

        /** allows callers to see the partially formed instance when needed, for example to query instantiators;
         *  could be replaced by specific methods as and when that is preferred */
        @SuppressWarnings("unchecked")
        public T peek() { return (T) AssemblyTemplate.this; }
        
        public synchronized Builder add(ApplicationComponentTemplate x) {
            if (AssemblyTemplate.this.applicationComponentTemplates==null) {
                AssemblyTemplate.this.applicationComponentTemplates = new BasicResourceLookup();
            }
            if (!(AssemblyTemplate.this.applicationComponentTemplates instanceof BasicResourceLookup)) {
                throw new IllegalStateException("Cannot add to resource lookup "+AssemblyTemplate.this.applicationComponentTemplates);
            }
            ((BasicResourceLookup)AssemblyTemplate.this.applicationComponentTemplates).add(x);
            return thisBuilder();
        }
        
        public synchronized Builder add(PlatformComponentTemplate x) {
            if (AssemblyTemplate.this.platformComponentTemplates==null) {
                AssemblyTemplate.this.platformComponentTemplates = new BasicResourceLookup();
            }
            if (!(AssemblyTemplate.this.platformComponentTemplates instanceof BasicResourceLookup)) {
                throw new IllegalStateException("Cannot add to resource lookup "+AssemblyTemplate.this.platformComponentTemplates);
            }
            ((BasicResourceLookup)AssemblyTemplate.this.platformComponentTemplates).add(x);
            return thisBuilder();
        }
        
        @Override
        public synchronized T build() {
            Preconditions.checkNotNull(AssemblyTemplate.this.instantiator);
            return super.build();
        }
    }

}