<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY metainfo SYSTEM "metainfo.sgm">
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY Dash "&ndash;">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="create-custom-resource-1">
<refmeta><refentrytitle>create-custom-resource</refentrytitle><manvolnum>
1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary></primary></indexterm><indexterm><primary
sortas="create-custom-resource">create-custom-resource &mdash;creates a custom
resouce</primary></indexterm><indexterm><primary sortas="creates a custom resource">
creates a custom resource &mdash; create-custom-resource</primary></indexterm>
<refname>create-custom-resource</refname><refpurpose>creates a custom resouce
</refpurpose></refnamediv><?Pub Caret>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>create-custom-resource</command>&synopsis-common;
<arg choice="plain">&Dash;&Dash;restype <replaceable>type</replaceable></arg>
<arg choice="plain">&Dash;&Dash;factoryclassname <replaceable>classname</replaceable></arg>
<arg><option>-enabled=<replaceable>true</replaceable></option></arg><arg choice="plain">&Dash;&Dash;description <replaceable>
text</replaceable></arg><arg><option role="nodash">&Dash;&Dash;property (<replaceable>
name</replaceable>=<replaceable>value</replaceable>)[:<replaceable>name</replaceable>=<replaceable>
value</replaceable>]*</option></arg><arg choice="plain"><replaceable>jndi_name
</replaceable></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</title>
<para>The <command>create-custom-resource</command> command creates a custom
resource. A custom resource specifies a custom server-wide resource object
factory that implements the <classname>javax.naming.spi.ObjectFactory</classname>
interface. This command is supported in remote mode only.</para>
</refsect1>
<refsect1><title>&opts-tt;</title>
<variablelist termlength="medium">&options-common;
<varlistentry><term><option role="nodash">&Dash;&Dash;target</option></term>
<listitem><para>This option helps specify the target to which you are deploying.
Valid values are: <itemizedlist>
<listitem><para><literal>server</literal>, which deploys the component to
the default server instance. This is the default value.</para>
</listitem>
<listitem><para><literal>domain</literal>, which deploys the component to
the domain.</para>
</listitem>
<listitem><para><replaceable>cluster_name</replaceable>, which deploys the
component to every server instance in the cluster.</para>
</listitem>
<listitem><para><replaceable>instance_name</replaceable>, which deploys the
component to a particular sever instance.</para>
</listitem>
</itemizedlist>&se-ee-only;</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;resourcetype</option></term>
<listitem><para>The <option role="nodash">&Dash;&Dash;resourcetype</option>
option is deprecated. Use <option role="nodash">&Dash;&Dash;restype</option>
instead.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;restype</option></term>
<listitem><para>The type of custom resource to be created. Specify a fully
qualified type definition, for example <classname>javax.naming.spi.ObjectFactory
</classname>. The resource type definition follows the format, xxx.xxx.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;factoryclass</option></term>
<listitem><para>Factory class name for the custom resource. This class implements
the <literal>javax.naming.spi.ObjectFactory</literal> interface.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;enabled</option></term>
<listitem><para>Determines whether the custom resource is enable at runtime.
The default value is true.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;description</option></term>
<listitem><para>Text providing details about the custom resource. This description
is a string value and can include a maximum of 250 characters.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;property</option></term>
<listitem><para>Optional attribute name/value pairs for configuring the resource. 
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&oper-tt;</title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>jndi_name</replaceable></term><listitem>
<para>the JNDI name of this resource.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&exam-tt;</title>
<example>
<title>Using the create-custom-resource command</title>
<screen>asadmin> <userinput>create-custom-resource --user admin --passwordfile passwords.txt 
--restype topic --factoryclass com.imq.topic sample_custom_resource</userinput>
Command create-custom-resource executed successfully.

</screen>
</example>
</refsect1>
<refsect1><title>&exit-tt;</title>
<variablelist termlength="medium">
<varlistentry><term>0</term><listitem><para>command executed successfully
</para>
</listitem></varlistentry>
<varlistentry><term>1</term><listitem><para>error in executing the command
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&also-tt;</title>
<para><link linkend="delete-custom-resource-1"><citerefentry><refentrytitle>
delete-custom-resource</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="list-custom-resources-1"><citerefentry><refentrytitle>list-custom-resources
</refentrytitle><manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000005919>
