Download as
Browse Code »

Commit 72e30aebbfb8a4d44374be33620f776391ebcea4

Authored by Cleverson Sacramento
1 parent 787f13be
Exists in master

Criação da tabela com todas as propriedades do core + extensions

Showing 1 changed file with 249 additions and 132 deletions   Show diff stats
documentation/reference/pt-BR/properties.xml
  Diff comments   View file @72e30ae
... ... @@ -3,147 +3,264 @@
3 3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]>
4 4 <chapter id="properties">
5 5  
6   - <title>Demoiselle Properties</title>
  6 + <title>Atributos do demoiselle.properties</title>
7 7  
8 8 <para>
9 9 Em um projeto com o <emphasis>Demoiselle Framework</emphasis>, algumas propriedades e configurações
10 10 do <emphasis>Framework</emphasis> podem ser ajustadas no arquivo <literal>demoiselle.properties</literal>.
11 11 A seguir listamos as propriedades e configurações do <emphasis>Demoiselle Framework</emphasis> que o usuário pode modificar,
12 12 acompanhados de alguns exemplos ilustrativos.
  13 +
13 14 </para>
14   -
15   - <section>
16   - <title>Configurações do Core</title>
17   - <para>
18   - <itemizedlist>
19   - <listitem>
20   - <para>
21   - <literal>frameworkdemoiselle.pagination.page.size</literal> - Configura o número de linhas que será
22   - exibido na grade de uma página. Por padrão, esse número é 10.
23   - </para>
24   - <para>
25   - Exemplo de configuração: <literal>frameworkdemoiselle.pagination.page.size=15</literal>, ajusta em 15
26   - a quantidade de linhas em uma grade
27   - </para>
28   - </listitem>
29   - <listitem>
30   - <para>
31   - <literal>frameworkdemoiselle.pagination.max.page.links</literal> - Configura a quantidade de links que
32   - será exibido em uma página. Por padrão, esse valor é 5.
33   - </para>
34   - <para>
35   - Exemplo de configuração: <literal>frameworkdemoiselle.pagination.max.page.links=20</literal>, configura em 20
36   - o número de links que podem ser exibidos em uma página.
37   - </para>
38   - </listitem>
39   - <listitem>
40   - <para>
41   - <literal>frameworkdemoiselle.security.enabled</literal> - Configura a habilitação das funcionalidades do
42   - <emphasis>Demoiselle</emphasis> relacionadas a segurança (como autenticação de usuário e verificação de
43   - permissão de acesso a recursos). Por padrão, essas funcionalidades ficam habilitadas.
44   - </para>
45   - <para>
46   - Exemplo de configuração: <literal>frameworkdemoiselle.security.enabled=false</literal>, desabilita as
47   - funcionalidades de segurança do <emphasis>Demoiselle</emphasis>.
48   - </para>
49   - </listitem>
50   - </itemizedlist>
51   - </para>
52   - </section>
53 15  
54   - <section>
55   - <title>Configurações da extensão JSF</title>
56   - <para>
57   - <itemizedlist>
58   - <listitem>
59   - <para>
60   - <literal>frameworkdemoiselle.security.login.page</literal> - Configura a página de login. Por padrão, a página
61   - configurada é <emphasis>“/login”</emphasis>.
62   - </para>
63   - <para>
64   - Exemplo de configuração: <literal>frameworkdemoiselle.security.login.page=“/inicial”</literal>, configura a
65   - página <emphasis>“/inicial”</emphasis> como a página de login.
66   - </para>
67   - </listitem>
68   -
69   - <listitem>
70   - <para>
71   - <literal>frameworkdemoiselle.security.redirect.after.login</literal> - Configura a página que será acessada após
72   - o login. Por padrão, a página configurada é <emphasis>“/index”</emphasis>.
73   - </para>
74   - <para>
75   - Exemplo de configuração: <literal>frameworkdemoiselle.security.redirect.after.login="/menu"</literal>, configura
76   - a página <emphasis>“/menu”</emphasis> para ser acessada no redirecionamento após o login do usuário.
77   - </para>
78   - </listitem>
79   -
80   - <listitem>
81   - <para>
82   - <literal>frameworkdemoiselle.security.redirect.after.logout</literal> - Configura a página para a qual a aplicação
83   - será direcionada após o logout do usuário. Por padrão, a página configurada é <emphasis>“/login”</emphasis>.
84   - </para>
85   - <para>
86   - Exemplo de configuração: <literal>frameworkdemoiselle.security.redirect.after.logout="/index"</literal>, configura
87   - a página "/index" para ser acessada no redirecionamento após o logout do usuário.
88   - </para>
89   - </listitem>
90   -
91   - <listitem>
92   - <para>
93   - <literal>frameworkdemoiselle.security.redirect.enebled</literal> - Configura a habilitação do redirecionamento da página
94   - após <emphasis>login</emphasis> e <emphasis>logout</emphasis>. Por padrão, o valor dessa propriedade é <emphasis>true</emphasis>.
95   - </para>
96   - <para>
97   - Exemplo de configuração: <literal>frameworkdemoiselle.security.redirect.enebled=false</literal>, desabilita os
98   - redirecionamentos de páginas após <emphasis>login</emphasis> e <emphasis>logout</emphasis>.
99   - </para>
100   - </listitem>
101   -
102   - <listitem>
103   - <para>
104   - <literal>frameworkdemoiselle.handle.application.exception</literal> - Define se a extensão vai capturar ou não alguma exceção
105   - lançada pela aplicação. Por padrão, essa configuração vem marcada como “true”, que diz para a extensão capturar a exceção.
106   - </para>
107   - <para>
108   - Exemplo de configuração: <emphasis>frameworkdemoiselle.handle.application.exception=false</emphasis>, desabilita a captura
109   - de exceções lançadas pela aplicação.
110   - </para>
111   - </listitem>
112   -
113   - <listitem>
114   - <para>
115   - <literal>frameworkdemoiselle.handle.aplication.exception.page</literal> - Configura a página para a qual a aplicação será
116   - direcionada em caso de exceção. Por padrão, a página configurada é <emphasis>“/application_error”</emphasis>.
117   - </para>
118   - <para>
119   - Exemplo de configuração: <emphasis>framework.handle.aplication.exception.page=“/exception_x_page”</emphasis>, redireciona a
120   - aplicação para a página <emphasis>/exception_x_page</emphasis> caso ocorra alguma exceção.
121   - </para>
122   - </listitem>
123   - </itemizedlist>
124   - </para>
125   - </section>
  16 + <para>
  17 + <table>
  18 + <title>Configurações do Core</title>
  19 + <tgroup cols="3">
  20 + <colspec align="left"/>
  21 + <colspec align="left"/>
  22 + <colspec align="right"/>
126 23  
127   - <section>
128   - <title>Configurações da Extensão JPA</title>
129   - <para>
130   - <itemizedlist>
131   - <listitem>
132   - <para>
133   - <literal>frameworkdemoiselle.persistence.unit.name</literal> - Quando é definida mais de uma unidade de persitencia
134   - no arquivo <literal>persistence.xml</literal>, muitas vezes é conveniente escolher uma unidade padrão, ao invés de
135   - definir as unidades individualmente em cada <emphasis>Entity Manager</emphasis>. Esse parâmetro é utilizado para
136   - indicar qual é a unidade de persistência que deve ser utilizada quando no <emphasis>Entity Manager</emphasis> não
137   - houver essa definição.
138   - </para>
139   - <para>
140   - Exemplo de configuração: <literal>frameworkdemoiselle.persistence.unit.name=database1-ds</literal>, configura a
141   - unidade de persistencia <literal>database1-ds</literal> como padrão da aplicação.
142   - </para>
143   - </listitem>
144   - </itemizedlist>
145   - </para>
146   - </section>
  24 + <thead>
  25 + <row valign="top">
  26 + <entry><emphasis role="bold">Propriedade</emphasis></entry>
  27 + <entry><emphasis role="bold">Descrição</emphasis></entry>
  28 + <entry><emphasis role="bold">Valor padrão</emphasis></entry>
  29 + </row>
  30 + </thead>
  31 + <tbody>
  32 + <row valign="top">
  33 + <entry>frameworkdemoiselle.security.enabled</entry>
  34 + <entry>
  35 + <para>
  36 + Habilita o mecanismo de segurança.
  37 + </para>
  38 + </entry>
  39 + <entry>true</entry>
  40 + </row>
  41 + <row valign="top">
  42 + <entry>frameworkdemoiselle.security.authenticator.class</entry>
  43 + <entry>
  44 + <para>
  45 + Define a classe que implementa a estratégia de autenticação.
  46 + </para>
  47 + </entry>
  48 + <entry></entry>
  49 + </row>
  50 + <row valign="top">
  51 + <entry>frameworkdemoiselle.security.authorizer.class</entry>
  52 + <entry>
  53 + <para>
  54 + Define a classe que implementa a estratégia de autorização.
  55 + </para>
  56 + </entry>
  57 + <entry></entry>
  58 + </row>
  59 + <row valign="top">
  60 + <entry>frameworkdemoiselle.transaction.class</entry>
  61 + <entry>
  62 + <para>
  63 + Define a classe que implementa a estratégia de controle transacional.
  64 + </para>
  65 + </entry>
  66 + <entry></entry>
  67 + </row>
  68 + <row valign="top">
  69 + <entry>frameworkdemoiselle.pagination.page.size</entry>
  70 + <entry>
  71 + <para>
  72 + Define o tamanho da página padrão do mecanismo de paginação.
  73 + </para>
  74 + </entry>
  75 + <entry>10</entry>
  76 + </row>
  77 + </tbody>
  78 + </tgroup>
  79 + </table>
  80 + <table>
  81 + <title>Configurações da extensão JSF</title>
  82 + <tgroup cols="3">
  83 + <colspec align="left"/>
  84 + <colspec align="left"/>
  85 + <colspec align="right"/>
  86 +
  87 + <thead>
  88 + <row valign="top">
  89 + <entry><emphasis role="bold">Propriedade</emphasis></entry>
  90 + <entry><emphasis role="bold">Descrição</emphasis></entry>
  91 + <entry><emphasis role="bold">Valor padrão</emphasis></entry>
  92 + </row>
  93 + </thead>
  94 + <tbody>
  95 + <row valign="top">
  96 + <entry>frameworkdemoiselle.security.login.page</entry>
  97 + <entry>
  98 + <para>
  99 + Define a página de login da aplicação.
  100 + </para>
  101 + </entry>
  102 + <entry>"/login"</entry>
  103 + </row>
  104 + <row valign="top">
  105 + <entry>frameworkdemoiselle.security.redirect.after.login</entry>
  106 + <entry>
  107 + <para>
  108 + Define a tela para qual o usuário será redirecionado após o processo de <emphasis>login</emphasis> bem sucedido.
  109 + </para>
  110 + </entry>
  111 + <entry>"/index"</entry>
  112 + </row>
  113 + <row valign="top">
  114 + <entry>frameworkdemoiselle.security.redirect.after.logout</entry>
  115 + <entry>
  116 + <para>
  117 + Define a tela para qual o usuário será redirecionado após o processo de <emphasis>logout</emphasis> bem sucedido.
  118 + </para>
  119 + </entry>
  120 + <entry>"/login"</entry>
  121 + </row>
  122 + <row valign="top">
  123 + <entry>frameworkdemoiselle.security.redirect.enabled</entry>
  124 + <entry>
  125 + <para>
  126 + Habilita os redirecionamentos relacionados aos processos de login e logout.
  127 + </para>
  128 + </entry>
  129 + <entry>true</entry>
  130 + </row>
  131 + <row valign="top">
  132 + <entry>frameworkdemoiselle.handle.application.exception</entry>
  133 + <entry>
  134 + <para>
  135 + Habilita o tratamento automático das exceções da aplicação anotadas com @ApplicationException.
  136 + </para>
  137 + </entry>
  138 + <entry>true</entry>
  139 + </row>
  140 + <row valign="top">
  141 + <entry>frameworkdemoiselle.handle.application.exception.page</entry>
  142 + <entry>
  143 + <para>
  144 + Define o redirecionamento das exceções da aplicação anotadas com @ApplicationException ocorridas
  145 + durante a fase de renderização da página (PhaseId.RENDER_RESPONSE).
  146 + </para>
  147 + </entry>
  148 + <entry>"/application_error"</entry>
  149 + </row>
  150 + <row valign="top">
  151 + <entry>frameworkdemoiselle.pagination.max.page.links</entry>
  152 + <entry>
  153 + <para>
  154 + Configura a quantidade de links que será exibido em uma página.
  155 + </para>
  156 + </entry>
  157 + <entry>5</entry>
  158 + </row>
  159 + </tbody>
  160 + </tgroup>
  161 + </table>
  162 + <table>
  163 + <title>Configurações da extensão JDBC</title>
  164 + <tgroup cols="3">
  165 + <colspec align="left"/>
  166 + <colspec align="left"/>
  167 + <colspec align="right"/>
  168 +
  169 + <thead>
  170 + <row valign="top">
  171 + <entry><emphasis role="bold">Propriedade</emphasis></entry>
  172 + <entry><emphasis role="bold">Descrição</emphasis></entry>
  173 + <entry><emphasis role="bold">Valor padrão</emphasis></entry>
  174 + </row>
  175 + </thead>
  176 + <tbody>
  177 + <row valign="top">
  178 + <entry>frameworkdemoiselle.persistence.jndi.name</entry>
  179 + <entry>
  180 + <para>
  181 + Define o nome JNDI onde o DataSource está disponível.
  182 + </para>
  183 + </entry>
  184 + <entry></entry>
  185 + </row>
  186 + <row valign="top">
  187 + <entry>frameworkdemoiselle.persistence.driver.class</entry>
  188 + <entry>
  189 + <para>
  190 + Define a classe que implementa o Driver de conexão com a base de dados.
  191 + </para>
  192 + </entry>
  193 + <entry></entry>
  194 + </row>
  195 + <row valign="top">
  196 + <entry>frameworkdemoiselle.persistence.url</entry>
  197 + <entry>
  198 + <para>
  199 + Define a URL de conexão com a base de dados.
  200 + </para>
  201 + </entry>
  202 + <entry></entry>
  203 + </row>
  204 + <row valign="top">
  205 + <entry>frameworkdemoiselle.persistence.username</entry>
  206 + <entry>
  207 + <para>
  208 + Define o username para estabelecer a conexão com a base de dados.
  209 + </para>
  210 + </entry>
  211 + <entry></entry>
  212 + </row>
  213 + <row valign="top">
  214 + <entry>frameworkdemoiselle.persistence.password</entry>
  215 + <entry>
  216 + <para>
  217 + Define o password para estabelecer a conexão com a base de dados.
  218 + </para>
  219 + </entry>
  220 + <entry></entry>
  221 + </row>
  222 + <row valign="top">
  223 + <entry>frameworkdemoiselle.persistence.default.datasource.name</entry>
  224 + <entry>
  225 + <para>
  226 + Define a configuração de banco de dados padrão para aplicações que possuem mais
  227 + de um datasource configurado.
  228 + </para>
  229 + </entry>
  230 + <entry></entry>
  231 + </row>
  232 + </tbody>
  233 + </tgroup>
  234 + </table>
  235 + <table>
  236 + <title>Configurações da extensão JPA</title>
  237 + <tgroup cols="3">
  238 + <colspec align="left"/>
  239 + <colspec align="left"/>
  240 + <colspec align="right"/>
  241 +
  242 + <thead>
  243 + <row valign="top">
  244 + <entry><emphasis role="bold">Propriedade</emphasis></entry>
  245 + <entry><emphasis role="bold">Descrição</emphasis></entry>
  246 + <entry><emphasis role="bold">Valor padrão</emphasis></entry>
  247 + </row>
  248 + </thead>
  249 + <tbody>
  250 + <row valign="top">
  251 + <entry>frameworkdemoiselle.persistence.default.unit.name</entry>
  252 + <entry>
  253 + <para>
  254 + Define a unidade de persistência padrão para aplicações que possuem mais
  255 + de um persistence-unit definido no arquivo persistence.xml.
  256 + </para>
  257 + </entry>
  258 + <entry></entry>
  259 + </row>
  260 + </tbody>
  261 + </tgroup>
  262 + </table>
  263 + </para>
147 264  
148 265 <!-- <section>
149 266 <title>Escolhendo Estratégias</title>
... ...