blob: 083bb22d5b39303b1d83d9bdef3664a7a6cd86d1 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Apache TomEE</title>
<meta name="description"
content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
<meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
<meta name="author" content="Luka Cvetinovic for Codrops" />
<link rel="icon" href="../../favicon.ico">
<link rel="icon" type="image/png" href="../../favicon.png">
<meta name="msapplication-TileColor" content="#80287a">
<meta name="theme-color" content="#80287a">
<link rel="stylesheet" type="text/css" href="../../css/normalize.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.css">
<link rel="stylesheet" type="text/css" href="../../css/owl.css">
<link rel="stylesheet" type="text/css" href="../../css/animate.css">
<link rel="stylesheet" type="text/css" href="../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="../../fonts/eleganticons/et-icons.css">
<link rel="stylesheet" type="text/css" href="../../css/jqtree.css">
<link rel="stylesheet" type="text/css" href="../../css/idea.css">
<link rel="stylesheet" type="text/css" href="../../css/cardio.css">
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-2717626-1']);
_gaq.push(['_setDomainName', 'apache.org']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div class="preloader">
<img src="../../img/loader.gif" alt="Preloader image">
</div>
<nav class="navbar">
<div class="container">
<div class="row"> <div class="col-md-12">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<span>
<img src="../../img/logo-active.png">
</span>
Apache TomEE
</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right main-nav">
<li><a href="../../docs.html">Documentation</a></li>
<li><a href="../../community/index.html">Community</a></li>
<li><a href="../../security/security.html">Security</a></li>
<li><a href="../../download-ng.html">Downloads</a></li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div></div>
</div>
<!-- /.container-fluid -->
</nav>
<div id="main-block" class="container main-block">
<div class="row title">
<div class="col-md-12">
<div class='page-header'>
<h1>Telnet Console</h1>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>{note} Availability: Since OpenEJB 0.9{note}</p>
</div>
</div>
</div>
<h1 id="_basic_usage" class="sect0">Basic Usage</h1>
<div class="paragraph">
<p>To use OpenEJB&#8217;s Telnet Console, simply boot your server normally.</p>
</div>
<div class="quoteblock">
<blockquote>
<div class="paragraph">
<p>$ ./bin/openejb start</p>
</div>
</blockquote>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-properties" data-lang="properties">OPENEJB_HOME=/Users/dblevins/Desktop/openejb-1.0
OpenEJB 1.0 build: 20060226-1701
http://www.openejb.org
resources 1
OpenEJB ready.
[init]</code></pre>
</div>
</div>
<div class="paragraph">
<p>OpenEJB Remote Server <strong> Starting Services </strong> NAME IP PORT<br>
webadmin 0.0.0.0 4203<br>
httpejbd 0.0.0.0 4204<br>
telnet 0.0.0.0 4202<br>
ejbd 0.0.0.0 4201<br>
admin 0.0.0.0 4200<br>
------- Ready!</p>
</div>
<div class="paragraph">
<p>Then in another shell telnet in</p>
</div>
<div class="quoteblock">
<blockquote>
<div class="paragraph">
<p>$ telnet localhost 4202</p>
</div>
</blockquote>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-properties" data-lang="properties">Trying ::1...
Connected to localhost.
Escape character is '^]</code></pre>
</div>
</div>
<div class="paragraph">
<p>'. OpenEJB Remote Server Console type 'help' for a list of commands
[openejb] $ help stop exit system version lookup help [openejb] $ system
Containers: Default BMP Container Default CMP Container Default Stateful
Container Default Stateless Container</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java" data-lang="java">Deployments:
client/tests/stateful/EncBean
client/tests/entity/cmp/RMI-over-IIOP/EJBHome
client/tests/stateful/BasicStatefulHome
ClientTools/ViewClass
Webadmin/Configuration
EJBGenerator/CreateEJB
ClientTools/InvokeObject
Webadmin/Properties
client/tests/stateful/RMI-over-IIOP/EJBHome
Webadmin/Home
client/tests/entity/bmp/allowed_operations/EntityHome
client/tests/entity/cmp/EncBean
httpd/DefaultBean
client/tests/stateful/BeanManagedBasicStatefulHome
client/tools/DatabaseHome
client/tests/entity/bmp/EncBean
config/webadmin/ConfigurationData
deploy/webadmin/Deployer
ClientTools/ViewJndi
Webadmin/DeploymentList
client/tests/stateless/BeanManagedBasicStatelessHome
Webadmin/CMPMapping
client/tests/stateless/EncBean
client/tests/stateful/BeanManagedTransactionTests/EJBHome
client/tests/entity/bmp/RMI-over-IIOP/EJBHome
Webadmin/ListLogs
client/tests/stateless/BeanManagedTransactionTests/EJBHome
ClientTools/ViewEjb
client/tests/entity/bmp/BasicBmpHome
mapping/webadmin/CMPMappingData
client/tests/stateless/BasicStatelessHome
client/tests/entity/cmp/BasicCmpHome
Webadmin/Deployment
httpd/session
client/tests/entity/cmp/allowed_operations/EntityHome
client/tests/stateless/RMI-over-IIOP/EJBHome
[openejb]</code></pre>
</div>
</div>
<div class="paragraph">
<p>$ exit Connection closed by foreign host.</p>
</div>
<h1 id="_configuring_the_telnet_service" class="sect0">Configuring the Telnet Service</h1>
<div class="paragraph">
<p>The configuration of all server services (network facing services) is
done in xinet.d style config files. The telnet shell is controlled via
the $OPENEJB_HOME/conf/telnet.properties file. This file is created for
you automatically after the first time OpenEJB boots.</p>
</div>
<div class="quoteblock">
<blockquote>
<div class="paragraph">
<p>$ cat conf/telnet.properties</p>
</div>
</blockquote>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-properties" data-lang="properties"> server = org.openejb.server.telnet.TelnetServer
bind = 127.0.0.1
port = 4202
disabled = false
threads = 5
# only_from = 192.168.1.123</code></pre>
</div>
</div>
<div class="paragraph">
<p>You can change the IP, port, and even the number of threads allowed to
concurrently access the Telnet service via this file.</p>
</div>
<h1 id="_disabling_the_telnet_service" class="sect0">Disabling the Telnet Service</h1>
<div class="paragraph">
<p>Simply edit the config file and set 'disabled' to true</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-properties" data-lang="properties"> disabled = true</code></pre>
</div>
</div>
<div class="paragraph">
<p>Then restart OpenEJB.</p>
</div>
<h1 id="_restricting_access" class="sect0">Restricting Access</h1>
<div class="paragraph">
<p>It is unlikely you want just anyone to be able to login and execute
commands. While you can&#8217;t restrict access on a user basis, yet, you can
restrict access to specific hosts. Host based access control (HBA) is a
built-in part of any Server Service in OpenEJB and the Telnet Service is
no different. This is done with the 'only_from' property, which like the
rest of the file is a direct copy of the xinet.d syntax for HBA.</p>
</div>
<div class="paragraph">
<p>For an example to restrict access to the localhost, you could configure
the Telnet Service like this:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-properties" data-lang="properties"> server = org.openejb.server.telnet.TelnetServer
bind = 127.0.0.1
port = 4202
disabled = false
threads = 5
only_from = localhost</code></pre>
</div>
</div>
<div class="paragraph">
<p>If you wanted to restrict access to localhost <em>and</em> say the hosts
192.168.1.207 and 192.168.1.16, you can simply add them to the list.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-properties" data-lang="properties"> server = org.openejb.server.telnet.TelnetServer
bind = 127.0.0.1
port = 4202
disabled = false
threads = 5
only_from = localhost, 192.168.1.207, 192.168.1.16</code></pre>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-sm-6 text-center-mobile">
<h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
<h5 class="light regular light-white">"A good application in a good server"</h5>
<ul class="social-footer">
<li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
<li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
<li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
</ul>
</div>
<div class="col-sm-6 text-center-mobile">
<div class="row opening-hours">
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../latest/docs/" class="white">Documentation</a></h5>
<ul class="list-unstyled">
<li><a href="../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
<li><a href="../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
<li><a href="../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
<li><a href="../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../latest/examples/" class="white">Examples</a></h5>
<ul class="list-unstyled">
<li><a href="../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
<li><a href="../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
<li><a href="../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
<li><a href="../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../community/index.html" class="white">Community</a></h5>
<ul class="list-unstyled">
<li><a href="../../community/contributors.html" class="regular light-white">Contributors</a></li>
<li><a href="../../community/social.html" class="regular light-white">Social</a></li>
<li><a href="../../community/sources.html" class="regular light-white">Sources</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../security/index.html" class="white">Security</a></h5>
<ul class="list-unstyled">
<li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
<li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
<li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="row bottom-footer text-center-mobile">
<div class="col-sm-12 light-white">
<p>Copyright &copy; 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
</div>
</div>
</div>
</footer>
<!-- Holder for mobile navigation -->
<div class="mobile-nav">
<ul>
<li><a hef="../../latest/docs/admin/index.html">Administrators</a>
<li><a hef="../../latest/docs/developer/index.html">Developers</a>
<li><a hef="../../latest/docs/advanced/index.html">Advanced</a>
<li><a hef="../../community/index.html">Community</a>
</ul>
<a href="#" class="close-link"><i class="arrow_up"></i></a>
</div>
<!-- Scripts -->
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/owl.carousel.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/wow.min.js"></script>
<script src="../../js/typewriter.js"></script>
<script src="../../js/jquery.onepagenav.js"></script>
<script src="../../js/tree.jquery.js"></script>
<script src="../../js/highlight.pack.js"></script>
<script src="../../js/main.js"></script>
</body>
</html>