com.strongloop.android.remoting.VirtualObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of strong-remoting-android Show documentation
Android client for strong-remoting
The newest version!
// Copyright (c) 2013 StrongLoop. All rights reserved.

package com.strongloop.android.remoting;

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

import com.strongloop.android.remoting.adapters.Adapter;

/**
 * A local representative of a single virtual object. The behavior of this
 * object is defined through a model defined on the server, and the identity
 * of this instance is defined through its `creationParameters`.
 */
public class VirtualObject {

    private Repository repository;
    private Map creationParameters;

    /**
     * Creates a new object not attached to any repository.
     */
    public VirtualObject() {
        this(null, null);
    }

    /**
     * Creates a new object from the given repository and parameters.
     * @param repository The repository this object should inherit from.
     * @param creationParameters The creationParameters of the new object.
     */
    public VirtualObject(Repository repository,
    		Map creationParameters) {
        setRepository(repository);
        setCreationParameters(creationParameters);
    }

    /**
     * Gets the {@link Repository} this object was created from.
     * @return the {@link Repository}.
     */
    @Transient
    public Repository getRepository() {
        return repository;
    }

    /**
     * Sets the {@link Repository} this object was created from.
     * @param repository The {@link Repository}.
     */
    @Transient
    public void setRepository(Repository repository) {
        this.repository = repository;
    }

    /**
     * Gets the creation parameters this object was created from.
     * @return the creation parameters.
     */
    @Transient
    public Map getCreationParameters() {
        return creationParameters;
    }

    /**
     * Sets the creation parameters this object was created from.
     * @param creationParameters The creation parameters.
     */
    @Transient
    public void setCreationParameters(
    		Map creationParameters) {
        this.creationParameters = creationParameters;
    }


    /**
     * Converts the object (and all of its Java Bean properties) into a
     * {@link java.util.Map}.
     */
    public Map toMap() {
        return BeanUtil.getProperties(this, false, false);
    }

    /**
     * Invokes a remotable method exposed within instances of this class on the
     * server.
     * @param method The method to invoke (without the repository), e.g.
     * "doSomething".
     * @param parameters The parameters to invoke with.
     * @param callback The callback to invoke when the execution finishes.
     */
    public void invokeMethod(String method,
            Map parameters,
            Adapter.Callback callback) {
        Adapter adapter = repository.getAdapter();
        if (adapter == null) {
            throw new IllegalArgumentException(
                    "Repository adapter cannot be null");
        }
        String path = repository.getClassName() + ".prototype." + method;
        adapter.invokeInstanceMethod(path, creationParameters, parameters,
        		callback);
    }

    /**
     * Invokes a remotable method exposed within instances of this class on the
     * server,
     * parses the response as binary data.
     * @param method The method to invoke (without the repository), e.g.
     * "doSomething".
     * @param parameters The parameters to invoke with.
     * @param callback The callback to invoke when the execution finishes.
     */
    public void invokeMethod(String method,
                             Map parameters,
                             Adapter.BinaryCallback callback) {
        Adapter adapter = repository.getAdapter();
        if (adapter == null) {
            throw new IllegalArgumentException(
                    "Repository adapter cannot be null");
        }
        String path = repository.getClassName() + ".prototype." + method;
        adapter.invokeInstanceMethod(path, creationParameters, parameters,
                callback);
    }
}