org.apache.cayenne.configuration.rop.client.ClientRuntime Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cayenne-client Show documentation

An aggregation of 1.4, 1.5 modules into an ROP client jar.

There is a newer version: 4.2.2

/*****************************************************************
 *   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.cayenne.configuration.rop.client;

import java.util.Collection;
import java.util.Map;

import org.apache.cayenne.configuration.CayenneRuntime;
import org.apache.cayenne.configuration.ModuleCollection;
import org.apache.cayenne.di.Module;
import org.apache.cayenne.remote.ClientConnection;

/**
 * A user application entry point to Cayenne stack on the ROP client.
 * 
 * @since 3.1
 */
public class ClientRuntime extends CayenneRuntime {

	private static ModuleCollection mainModule(Map properties) {
		return new ModuleCollection(new ClientModule(properties));
	}

	/**
	 * Creates a client runtime configuring it with a standard set of services
	 * contained in {@link ClientModule}. CayenneClientModule is created based
	 * on a set of properties that contain things like connection information,
	 * etc. Recognized property keys are defined in {@link ClientModule}. An
	 * optional array of extra modules may contain service overrides and/or user
	 * services.
	 */
	public ClientRuntime(Map properties, Collection extraModules) {
		super(mainModule(properties).add(extraModules));
	}

	/**
	 * Creates a client runtime configuring it with a standard set of services
	 * contained in {@link ClientModule}. CayenneClientModule is created based
	 * on a set of properties that contain things like connection information,
	 * etc. Recognized property keys are defined in {@link ClientModule}. An
	 * optional collection of extra modules may contain service overrides and/or
	 * user services.
	 */
	public ClientRuntime(Map properties, Module... extraModules) {
		super(mainModule(properties).add(extraModules));
	}

	public ClientConnection getConnection() {
		return injector.getInstance(ClientConnection.class);
	}

}