1/*
2 * Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.activation;
27
28import java.io.IOException;
29
30/**
31 * JavaBeans components that are Activation Framework aware implement
32 * this interface to find out which command verb they're being asked
33 * to perform, and to obtain the DataHandler representing the
34 * data they should operate on.  JavaBeans that don't implement
35 * this interface may be used as well.  Such commands may obtain
36 * the data using the Externalizable interface, or using an
37 * application-specific method.
38 *
39 * @since 1.6
40 */
41public interface CommandObject {
42
43    /**
44     * Initialize the Command with the verb it is requested to handle
45     * and the DataHandler that describes the data it will
46     * operate on. <b>NOTE:</b> it is acceptable for the caller
47     * to pass <i>null</i> as the value for {@code DataHandler}.
48     *
49     * @param verb The Command Verb this object refers to.
50     * @param dh The DataHandler.
51     * @exception       IOException     for failures accessing data
52     */
53    public void setCommandContext(String verb, DataHandler dh)
54                                                throws IOException;
55}
56