TaskClient.java

package de.zib.gndms.gndmc.gorfx;
/*
 * Copyright 2008-2011 Zuse Institute Berlin (ZIB)
 *
 * 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.
 */

import de.zib.gndms.common.GORFX.service.TaskService;
import de.zib.gndms.common.model.gorfx.types.*;
import de.zib.gndms.common.rest.Facets;
import de.zib.gndms.common.rest.Specifier;
import de.zib.gndms.common.rest.UriFactory;
import de.zib.gndms.common.stuff.devel.NotYetImplementedException;
import de.zib.gndms.gndmc.AbstractClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;

import java.util.HashMap;
import java.util.Map;

/**
 * @author try ma ik jo rr a zib
 * @date 07.03.11  18:35
 * @brief Client for TaskService.
 *
 * @see de.zib.gndms.common.GORFX.service.TaskService for details.
 */
public class TaskClient extends AbstractClient implements TaskService {

   private UriFactory uriFactory;


    public TaskClient() {
    }


    public TaskClient( String serviceURL ) {
        super( serviceURL );
        uriFactory = new UriFactory( serviceURL );
    }


    public ResponseEntity<TaskServiceInfo> getServiceInfo( final String dn ) {
        return unifiedGet( TaskServiceInfo.class,
            uriFactory.taskServiceUri( new HashMap<String,String> () {{put( "service", "gorfx" );}} ), dn );
    }


    public ResponseEntity<TaskServiceConfig> getServiceConfig( String dn ) {
        return unifiedGet( TaskServiceConfig.class,
            uriFactory.taskServiceUri( new HashMap<String,String> () {{put( "service", "gorfx" );}}, "config" ), dn );
    }


    public ResponseEntity<String> setServiceConfig( TaskServiceConfig cfg, String dn ) {
        throw new NotYetImplementedException();
    }


    public ResponseEntity<Facets> getTaskFacets( final String id, String dn ) {
        return unifiedGet( Facets.class,
            uriFactory.taskUri( new HashMap<String, String>() {{
                put( "service", "gorfx" );
                put( "taskId", id );
            }}, null ), dn );
    }


    public ResponseEntity<Integer> deleteTask( final String id, String dn, String wid ) {
        return unifiedDelete(
            uriFactory.taskUri( new HashMap<String, String>() {{
                put( "service", "gorfx" );
                put( "taskId", id );
            }}, null ), dn, wid );
    }


    public ResponseEntity<TaskStatus> getStatus( final String id, String dn, String wid ) {
        return unifiedGet( TaskStatus.class,
            uriFactory.taskUri( new HashMap<String, String>() {{
                put( "service", "gorfx" );
                put( "taskId", id );
            }}, "status" ), dn, wid );
    }


    public ResponseEntity<Integer> changeStatus( final String id, TaskControl status, String dn, String wid ) {
        return unifiedPost( Integer.class,
            uriFactory.taskUri( new HashMap<String, String>() {{
                put( "service", "gorfx" );
                put( "taskId", id );
            }}, "status" ), dn, wid );
    }


    public ResponseEntity<TaskResult> getResult( final String id, String dn, String wid ) {
        return unifiedGet( TaskResult.class,
            uriFactory.taskUri( new HashMap<String,String> () {{
                put( "service", "gorfx" );
                put( "taskId", id );
            }}, "result" ), dn, wid );
    }


    public ResponseEntity<TaskFailure> getErrors( final String id, String dn, String wid ) {
        return unifiedGet( TaskFailure.class,
            uriFactory.taskUri( new HashMap<String,String> () {{
                put( "service", "gorfx" );
                put( "taskId", id );
            }}, "errors" ), dn, wid );
    }


    @Override
    public void setServiceURL( String serviceURL ) {
        uriFactory = new UriFactory( serviceURL );
        super.setServiceURL( serviceURL );
    }


    /**
     * Some convenience methods for task handling
     * @author try ma ik jo rr a zib
     * @date 30.05.11  16:38
     * @brief
     */
    public static class TaskServiceAux {

        private final static Logger logger = LoggerFactory.getLogger( TaskServiceAux.class );


        public static Specifier<Facets> getTaskSpecifier( TaskClient taskClient, String taskId,
                                                    UriFactory uriFactory, Map<String,String> urimap, String dn ) {

            Specifier<Facets> spec = new Specifier<Facets>();

            Map<String, String> taskurimap = taskUriMap( taskId, urimap );

            spec.setUrl( uriFactory.taskUri( taskurimap, null ) );
            spec.setUriMap( taskurimap );

            ResponseEntity<Facets> res = taskClient.getTaskFacets( taskId, dn );
            if( res != null )
                if( HttpStatus.OK.equals( res.getStatusCode() ) ) {
                    spec.setPayload( res.getBody() );
                } else {
                    throw new IllegalStateException( "unexpected status: " + res.getStatusCode().name() );
                }
            else
                logger.debug( "getTaskFacets returned null" );

            return spec;
        }


        public static Map<String, String> taskUriMap( String taskId, Map<String,String> urimap ) {

            HashMap<String,String> newUrimap = new HashMap<String, String>( 2 );
            newUrimap.put( UriFactory.SERVICE, "gorfx" );
            newUrimap.put( UriFactory.TASK_ID, taskId );

            if ( urimap != null )
                newUrimap.putAll( urimap ); // this might overwrite TASK_ID and SERVICE

            return newUrimap;
        }


        private TaskServiceAux( ) {}
    }
}