net.jxta.impl.shell.bin.publish.publish Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jxse-shell Show documentation

The JXTA Shell is a sample application that demonstrates key concepts of JXTA JXSE. The JXTA Shell enables users to interact with the JXTA platform through a command-line interpreter. Much like the UNIX® shell, the JXTA Shell is useful for accessing and managing core platform objects (peers, groups, pipes), debugging communications problems, checking the status of peers and/or peer groups, and communicating with other JXTA services and applications. As in UNIX®, the JXTA shell allows users to "pipe" shell commands together connecting commands "on-the-fly." Pipes in Project JXTA are useful for collecting information at one peer and perhaps processing the command at another.

The newest version!

/*
 *  Copyright (c) 2001 Sun Microsystems, Inc.  All rights
 *  reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *  notice, this list of conditions and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright
 *  notice, this list of conditions and the following disclaimer in
 *  the documentation and/or other materials provided with the
 *  distribution.
 *
 *  3. The end-user documentation included with the redistribution,
 *  if any, must include the following acknowledgment:
 *  "This product includes software developed by the
 *  Sun Microsystems, Inc. for Project JXTA."
 *  Alternately, this acknowledgment may appear in the software itself,
 *  if and wherever such third-party acknowledgments normally appear.
 *
 *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
 *  not be used to endorse or promote products derived from this
 *  software without prior written permission. For written
 *  permission, please contact Project JXTA at http://www.jxta.org.
 *
 *  5. Products derived from this software may not be called "JXTA",
 *  nor may "JXTA" appear in their name, without prior written
 *  permission of Sun.
 *
 *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED.  IN NO EVENT SHALL SUN MICROSYSTEMS OR
 *  ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 *  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 *  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 *  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *  ====================================================================
 *
 *  This software consists of voluntary contributions made by many
 *  individuals on behalf of Project JXTA.  For more
 *  information on Project JXTA, please see
 *  .
 *
 *  This license is based on the BSD license adopted by the Apache Foundation.
 *
 *  $Id: publish.java,v 1.13 2007/02/09 23:12:54 hamada Exp $
 */
package net.jxta.impl.shell.bin.publish;

import net.jxta.discovery.DiscoveryService;
import net.jxta.document.Advertisement;
import net.jxta.document.AdvertisementFactory;
import net.jxta.document.MimeMediaType;
import net.jxta.document.XMLDocument;
import net.jxta.impl.shell.GetOpt;
import net.jxta.impl.shell.ShellApp;
import net.jxta.impl.shell.ShellEnv;
import net.jxta.impl.shell.ShellObject;

import java.io.IOException;

/**
 * Publish a JXTA advertisement
 */
public class publish extends ShellApp {

    /**
     * {@inheritDoc}
     */
    public int startApp(String[] args) {
        ShellEnv env = getEnv();
        boolean remote = false;
        long lifetime = DiscoveryService.DEFAULT_LIFETIME;
        long expiration = DiscoveryService.DEFAULT_EXPIRATION;

        GetOpt options = new GetOpt(args, 0, "rl:e:");

        while (true) {
            int option;
            try {
                option = options.getNextOption();
            } catch (IllegalArgumentException badopt) {
                consoleMessage("Illegal argument :" + badopt);
                return syntaxError();
            }

            if (-1 == option) {
                break;
            }

            switch (option) {
                case'r':
                    remote = true;
                    break;
                case'l':
                    lifetime = Long.parseLong(options.getOptionArg());
                    break;
                case'e':
                    expiration = Long.parseLong(options.getOptionArg());
                    break;
                default:
                    consoleMessage("Unrecognized option");
                    return syntaxError();
            }
        }

        String name = options.getNextParameter();

        if (null == name) {
            consoleMessage("Missing  parameter.");
            return syntaxError();
        }

        if (null != options.getNextParameter()) {
            consoleMessage("Unsupported parameter.");
            return syntaxError();
        }

        if (remote && (DiscoveryService.DEFAULT_LIFETIME != lifetime)) {
            consoleMessage("Advertisement '" + name + "' not found.");
        }

        ShellObject obj = env.get(name);
        if (obj == null) {
            consoleMessage("Advertisement '" + name + "' not found.");
            return ShellApp.appMiscError;
        }

        Object adv = obj.getObject();
        if (adv instanceof XMLDocument) {
            try {
                adv = AdvertisementFactory.newAdvertisement(MimeMediaType.XMLUTF8, ((XMLDocument) adv).getStream());
            } catch (IOException io) {
                printStackTrace("Error converting document to Advertisement object. ", io);
            }
        }
        if (adv instanceof Advertisement) {
            try {
                DiscoveryService discovery = getGroup().getDiscoveryService();
                if (!remote) {
                    discovery.publish((Advertisement) adv, lifetime, expiration);
                } else {
                    discovery.remotePublish((Advertisement) adv, expiration);
                }
            } catch (IOException e) {
                printStackTrace("Error publishing Advertisement object. ", e);
                return ShellApp.appMiscError;
            }
        } else {
            consoleMessage("Object is not an advertisement");
            return ShellApp.appMiscError;
        }

        return ShellApp.appNoError;
    }

    private int syntaxError() {
        consoleMessage("usage : publish [-r | -l ] [-e ]  ");
        return ShellApp.appParamError;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getDescription() {
        return "Publish a JXTA advertisement";
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void help() {
        println("NAME");
        println("     publish - " + getDescription());
        println(" ");
        println("SYNOPSIS");
        println("    publish [-r | -l ] [-e ]  ");
        println(" ");
        println("DESCRIPTION");
        println(" ");
        println("Use 'publish' to publish an advertisement into cache ");
        println(" ");
        println("OPTIONS");
        println("    -r           Remote publish.");
        println("    -l   Lifetime in milliseconds.");
        println("    -e   Expiration in milliseconds.");
        println(" ");
        println("PARAMETERS");
        println("        Advertisement to publish");
        println(" ");
        println("EXAMPLE");
        println(" ");
        println("    JXTA>publish peer10");
        println(" ");
        println("    publish the peer advertisement peer10");
        println(" ");
    }
}