DockerOOMDetector.java

/*******************************************************************************
 * Copyright (c) 2012-2016 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.plugin.docker.client;

import com.google.inject.ImplementedBy;

/**
 * Detects container OOM and put message about it to log processor of container.
 *
 * @author Alexander Garagatyi
 */
@ImplementedBy(DockerOOMDetector.NoOpDockerOOMDetector.class)
public interface DockerOOMDetector {

    /**
     * Stops detection of OOM for specified container.
     *
     * @param container
     *         container id to stop OOM detection for
     */
    void stopDetection(String container);

    /**
     * Starts detection of OOM for specified container.
     * Does nothing if container is under OOM detection already.
     * Also puts message about OOM to processor of container logs.
     *
     * @param container
     *         container id to stop OOM detection for
     * @param startContainerLogProcessor
     *         processor of container logs to put message about OOM detection
     */
    void startDetection(String container, MessageProcessor<LogMessage> startContainerLogProcessor);

    DockerOOMDetector NOOP_DETECTOR = new NoOpDockerOOMDetector();

    class NoOpDockerOOMDetector implements DockerOOMDetector {
        @Override
        public void stopDetection(String container) {
        }

        @Override
        public void startDetection(String container, MessageProcessor<LogMessage> startContainerLogProcessor) {
        }
    }
}