forked from ebean-orm/ebean-orm.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathserverconfig.html
More file actions
277 lines (243 loc) · 13.1 KB
/
serverconfig.html
File metadata and controls
277 lines (243 loc) · 13.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<!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">
<meta id="layout-head" />
<title>Ebean ORM Setup</title>
<link rel="shortcut icon" href="/images/favicon.ico" >
<!--<link href="/css/bootstrap.min.css" rel="stylesheet">-->
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<link rel="stylesheet" href="/css/pygments.css" type="text/css" />
<link rel="stylesheet" href="/css/site.css">
<link rel="stylesheet" href="//netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div id="wrap">
<div id="header">
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".mobile-nav">
<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="/"><img src="/images/logo-black-3.png" width="32" style="display: inline;">Ebean ORM</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav pull-right">
<li ><a href="/"><span class="glyphicon glyphicon-home"></span> Home</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a href="/quickstart">Quick Start</a></li>
<li ><a href="/support">Support</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a target="_blank" href="/apidoc/10">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li ><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fa fa-github"></i> Github</a></li>
</ul> </div>
<div class="mobile-nav">
<ul class="nav navbar-nav pull-right">
<li ><a href="/"><span class="glyphicon glyphicon-home"></span> Home</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a href="/quickstart">Quick Start</a></li>
<li ><a href="/support">Support</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a target="_blank" href="/apidoc/10">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li ><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fa fa-github"></i> Github</a></li>
</ul> </div>
</div>
</div>
</div>
<div id="main" data-offset="60">
<div class="jumbotron mini">
<div class="container">
<h1><a href="/docs">Documentation</a> / <a href="/docs/setup">Setup</a> / ServerConfig </h1>
</div>
</div>
<div class="container doc-index bs-docs-container">
<div class="row">
<div class="col-md-9" role="main">
<div class="bs-docs-section">
<h2 id="overview">Overview</h2>
<p>
Configuration of EbeanServer instances is defined by the <code>ServerConfig</code> bean. It has a series of
getters and setters for all the configuration options available.
</p>
<p>
In code terms a new ServerConfig instance is created and configured by either caller setter methods or
loading configuration from ebean.properties or external properties. Finally <code>EbeanServerFactory</code>
is used to take the ServerConfig and create an <code>EbeanServer</code> instance.
</p>
<h2 id="ebean-properties">ebean.properties</h2>
<p>
The <code>ServerConfig.loadFromProperties()</code> loads configuration from <code>ebean.properties</code> file.
This is can be used where some properties are set via code (calling setter methods on ServerConfig)
and some from ebean.properties.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">ServerConfig</span> <span class="n">config</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ServerConfig</span><span class="o">();</span>
<span class="n">config</span><span class="o">.</span><span class="na">setName</span><span class="o">(</span><span class="s">"pg"</span><span class="o">);</span>
<span class="o">...</span>
<span class="c1">// load configuration from ebean.properties</span>
<span class="c1">// using "pg" as the server name</span>
<span class="n">config</span><span class="o">.</span><span class="na">loadFromProperties</span><span class="o">();</span>
<span class="o">...</span>
<span class="n">EbeanServer</span> <span class="n">server</span> <span class="o">=</span> <span class="n">EbeanServerFactory</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">config</span><span class="o">);</span>
</pre></div>
</div>
<h2 id="external-properties">External properties</h2>
<p>
You can have an external mechanism for loading <code>Properties</code> and supply this to ServerConfig via:
<code>ServerConfig.loadFromProperties(Properties)</code>. This is can be used where some configuration is set
via the externally loaded properties and some is set via code (calling setter methods on ServerConfig).
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// load properties externally</span>
<span class="n">Properties</span> <span class="n">externalProps</span> <span class="o">=</span> <span class="o">...;</span>
<span class="n">ServerConfig</span> <span class="n">config</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ServerConfig</span><span class="o">();</span>
<span class="n">config</span><span class="o">.</span><span class="na">setName</span><span class="o">(</span><span class="s">"pg"</span><span class="o">);</span>
<span class="o">...</span>
<span class="c1">// load configuration from external properties</span>
<span class="c1">// using "pg" as the server name</span>
<span class="n">config</span><span class="o">.</span><span class="na">loadFromProperties</span><span class="o">(</span><span class="n">externalProps</span><span class="o">);</span>
<span class="o">...</span>
<span class="n">EbeanServer</span> <span class="n">server</span> <span class="o">=</span> <span class="n">EbeanServerFactory</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">config</span><span class="o">);</span>
</pre></div>
</div>
<h2 id="register">Register</h2>
<p>
By default ServerConfig has register=true and this means that the EbeanServer instance is registered with
the Ebean singleton and can be later accessed via <code>Ebean.getServer(serverName)</code>
</p>
<p>
You need to explicitly ServerConfig.setRegister(false) if you don't this feature.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">ServerConfig</span> <span class="n">config</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ServerConfig</span><span class="o">();</span>
<span class="n">config</span><span class="o">.</span><span class="na">setName</span><span class="o">(</span><span class="s">"pg"</span><span class="o">);</span>
<span class="o">...</span>
<span class="n">EbeanServer</span> <span class="n">server</span> <span class="o">=</span> <span class="n">EbeanServerFactory</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">config</span><span class="o">);</span>
<span class="o">...</span>
<span class="c1">// Later on we can get the server instance</span>
<span class="c1">// using it's name via Ebean</span>
<span class="n">EbeanServer</span> <span class="n">server</span> <span class="o">=</span> <span class="n">Ebean</span><span class="o">.</span><span class="na">getServer</span><span class="o">(</span><span class="s">"pg"</span><span class="o">);</span>
</pre></div>
</div>
<h2 id="default">Default server</h2>
<p>
You can set ServerConfig.setDefaultServer(true) to indicate that the EbeanServer instance created should
be the 'default' EbeanServer and can be later accessed via <code>Ebean.getDefaultServer()</code>
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">ServerConfig</span> <span class="n">config</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ServerConfig</span><span class="o">();</span>
<span class="n">config</span><span class="o">.</span><span class="na">setName</span><span class="o">(</span><span class="s">"pg"</span><span class="o">);</span>
<span class="n">config</span><span class="o">.</span><span class="na">setDefaultServer</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="o">...</span>
<span class="n">EbeanServer</span> <span class="n">server</span> <span class="o">=</span> <span class="n">EbeanServerFactory</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">config</span><span class="o">);</span>
<span class="o">...</span>
<span class="c1">// Later on we can get the server instance ...</span>
<span class="n">EbeanServer</span> <span class="n">server</span> <span class="o">=</span> <span class="n">Ebean</span><span class="o">.</span><span class="na">getDefaultServer</span><span class="o">();</span>
<span class="c1">// Note: serverName of null is the same as getting the default server</span>
<span class="n">EbeanServer</span> <span class="n">server</span> <span class="o">=</span> <span class="n">Ebean</span><span class="o">.</span><span class="na">getServer</span><span class="o">(</span><span class="kc">null</span><span class="o">);</span>
</pre></div>
</div>
<h2 id="di">Dependency injection</h2>
<p>
For dependency injection with Guice, Spring and similar DI frameworks typically a "provider" or "factory"
is required that creates a ServerConfig, configures it as required perhaps using ebean.properties or
external properties and then uses <code>EbeanServerFactory</code> to create the EbeanServer instance.
</p>
<h4>Inject and ActiveRecord</h4>
<p>
It is common and expected that you want to be able to both <code>@Inject</code> <code>EbeanServer</code>
instances in the traditional DI coding style <em>and also</em> use the active record style. This can be done
when the EbeanServer instances are created with <code>register</code> as true and one instance marked
as the <code>default server</code>.
</p>
</div>
</div>
<div class="col-md-3" role="complementary">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm">
<ul class="nav bs-docs-sidenav">
<li >
<a href="/docs/setup/enhancement">Enhancement</a>
</li>
<li >
<a href="/docs/setup/eclipse-apt">Eclipse IDE - APT</a>
</li>
<li >
<a href="/docs/setup/logging">Logging</a>
</li>
<li class="active">
<a href="/docs/setup/serverconfig">ServerConfig</a>
<ul class="nav">
<li><a href="#overview">Overview</a></li>
<li><a href="#ebean-properties">ebean.properties</a></li>
<li><a href="#external-properties">External properties</a></li>
<li><a href="#server">Register</a></li>
<li><a href="#default">Default server</a></li>
<li><a href="#di">Dependency injection</a></li>
</ul>
</li>
<li >
<a href="/docs/setup/guice">Guice</a>
</li>
<li >
<a href="/docs/setup/spring">Spring</a>
</li>
<li >
<a href="/docs/setup/activerecord">Active Record</a>
</li>
<li >
<a href="/docs/setup/ddl-create-all">DDL - Create All</a>
</li>
<li >
<a href="/docs/setup/dbmigration">DDL - DB Migration</a>
</li>
<li >
<a href="/docs/setup/test-properties"> Test properties</a>
</li>
<li >
<a href="/docs/setup/testing">Testing</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<!-- /.row -->
</div> <!-- /.container -->
</div>
</div>
<footer id="footer">
<div class="doc-footer">
<ul class="doc-footer-links">
<li><a href="/">Ebean ORM</a></li>
<li> | </li>
<li><a href="http://avaje-metric.github.io">Metrics</a></li>
</ul>
</div>
</footer>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<script src="/js/bootstrap.min.js"></script>
<script src="/js/jquery.easing.min.js"></script>
<script src="/js/json2.js"></script>
<script src="/js/jquery.cookie.min.js"></script>
<script src="/js/jquery.storageapi.min.js"></script>
<script src="/js/ebean-site.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-75181644-1', 'auto');
ga('send', 'pageview');
</script> </body>
</html>