All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • io.continual.http.app.servers.routeInstallers.BaseRouteInstaller Maven / Gradle / Ivy

    /*
 *	Copyright 2019, Continual.io
 *
 *	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 io.continual.http.app.servers.routeInstallers;

import java.io.IOException;
import java.io.InputStream;
import java.util.LinkedList;

import org.json.JSONObject;
import org.slf4j.Logger;

import io.continual.builder.Builder.BuildFailure;
import io.continual.http.app.servers.CorsOptionsRouter;
import io.continual.http.service.framework.CHttpErrorHandler;
import io.continual.http.service.framework.CHttpRouteInstaller;
import io.continual.http.service.framework.context.CHttpRequestContext;
import io.continual.http.service.framework.routing.CHttpRequestRouter;
import io.continual.http.service.framework.routing.CHttpRouteSource;
import io.continual.http.service.framework.routing.playish.CHttpPlayishInstanceCallRoutingSource;
import io.continual.http.service.framework.routing.playish.CHttpPlayishRoutingFileSource;
import io.continual.resources.ResourceLoader;
import io.continual.util.nv.NvReadable;
import io.continual.util.standards.MimeTypes;

public class BaseRouteInstaller implements CHttpRouteInstaller
{
	public BaseRouteInstaller ()
	{
		this ( true );
	}

	public BaseRouteInstaller ( boolean withCors )
	{
		fWithCors = withCors;
		fRouteEntries = new LinkedList<> ();
		fErrorHandlerEntries = new LinkedList<> ();
	}

	public BaseRouteInstaller registerRouteSource ( CHttpRouteSource routeSource )
	{
		fRouteEntries.add ( routeSource );
		return this;
	}

	@Override
	public void setupRouter ( CHttpRequestRouter rr, NvReadable prefs ) throws IOException 
	{
		if ( fWithCors )
		{
			setupCorsHandler ( rr );
		}
		setupExceptionHandlers ( rr );

		for ( CHttpRouteSource rs : fRouteEntries )
		{
			rr.addRouteSource ( rs );
		}
	}

	public BaseRouteInstaller registerRoutes ( String routeFile, Object handler ) throws BuildFailure
	{
		return registerRoutes ( routeFile, this.getClass (), handler );
	}

	public BaseRouteInstaller registerRoutes ( String routeFile, Class clazz, Object handler ) throws BuildFailure
	{
		try (
			final InputStream is = new ResourceLoader ()
				.usingStandardSources ( false, clazz )
				.named ( routeFile )
				.load ()
			;
		)
		{
			if ( is == null )
			{
				throw new BuildFailure ( "Unable to load " + routeFile + "." );
			}
			registerRoutes ( is, handler );
		}
		catch ( IOException x )
		{
			throw new BuildFailure ( x );
		}

		return this;
	}

	public BaseRouteInstaller registerRoutes ( InputStream routeFile, Object handler ) throws BuildFailure
	{
		if ( routeFile == null )
		{
			throw new BuildFailure ( "Received a null input stream for routes." );
		}

		try
		{
			registerRouteSource ( new CHttpPlayishInstanceCallRoutingSource ( handler, routeFile ) );
		}
		catch ( IOException x )
		{
			throw new BuildFailure ( x );
		}

		return this;
	}

	public BaseRouteInstaller registerStaticRoutes ( String routeFile, Class clazz ) throws BuildFailure
	{
		try
		{
			registerRouteSource ( new CHttpPlayishRoutingFileSource ( new ResourceLoader ()
				.usingStandardSources ( false, clazz )
				.named ( routeFile ) )
			);
		}
		catch ( IOException x )
		{
			throw new BuildFailure ( x );
		}
		return this;
	}

	public BaseRouteInstaller registerErrorHandler ( Class exClass, CHttpErrorHandler handler )
	{
		fErrorHandlerEntries.add ( new ErrHandlerEntry ( exClass, handler ) );
		return this;
	}

	public BaseRouteInstaller registerErrorHandler ( Class exClass, int statusCode )
	{
		return registerErrorHandler ( exClass, statusCode, null, null );
	}

	public BaseRouteInstaller registerErrorHandler ( Class exClass, int statusCode, Logger log )
	{
		return registerErrorHandler ( exClass, statusCode, null, log );
	}

	public BaseRouteInstaller registerErrorHandler ( Class exClass, final int statusCode, final String configuredMsg )
	{
		return registerErrorHandler ( exClass, statusCode, configuredMsg, null );
	}

	public BaseRouteInstaller registerErrorHandler ( Class exClass, final int statusCode, final String configuredMsg, Logger log )
	{
		return registerErrorHandler ( exClass, new CHttpErrorHandler ()
		{
			@Override
			public void handle ( CHttpRequestContext ctx, Throwable cause )
			{
				final String actualMsg = configuredMsg == null ? cause.getMessage () : configuredMsg;

				ctx.response ().sendStatusAndBody ( statusCode, 
					new JSONObject ()
						.put ( "error", statusCode )
						.put ( "message", actualMsg )
						.toString (),
					MimeTypes.kAppJson );

				if ( log != null )
				{
					log.warn ( actualMsg, cause );
				}
			}
		} );
	}

	protected void setupCorsHandler ( CHttpRequestRouter rr )
	{
		// general purpose OPTIONS handler
		rr.addRouteSource ( new CorsOptionsRouter () );
	}

	protected void setupExceptionHandlers ( CHttpRequestRouter rr )
	{
		for ( ErrHandlerEntry ehe : fErrorHandlerEntries )
		{
			rr.setHandlerForException ( ehe.getExceptionClass (), ehe.getHandler () );
		}
	}

	private class ErrHandlerEntry
	{
		public ErrHandlerEntry ( Class exClass, CHttpErrorHandler handler )
		{
			fEx = exClass;
			fHandler = handler;
		}

		public Class getExceptionClass () { return fEx; }
		public CHttpErrorHandler getHandler () { return fHandler; }

		private final Class fEx;
		private final CHttpErrorHandler fHandler;
	}
	
	private final boolean fWithCors;
	private final LinkedList fRouteEntries;
	private final LinkedList fErrorHandlerEntries;
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy