View Javadoc

1   /*
2    * Copyright 2012 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.ci.maven;
17  
18  /**
19   * The proxy information.
20   */
21  public final class ProxyConfiguration
22  {
23    // ********************************* Fields *********************************
24  
25    // --- constants ------------------------------------------------------------
26  
27    // --- members --------------------------------------------------------------
28  
29    /**
30     * The id of the proxy entry in the maven settings.
31     */
32    private String id;
33  
34    /**
35     * The specified proxy host.
36     */
37    private String host;
38  
39    /**
40     * The specified proxy port.
41     */
42    private int port;
43  
44    /**
45     * The password to authenticate against the proxy.
46     */
47    private String password;
48  
49    /**
50     * The userName to authenticate against the proxy.
51     */
52    private String userName;
53  
54    /**
55     * The windows NT-Domain the user uses to connect to the proxy.
56     */
57    private String domain;
58  
59    /**
60     * The client name from which the connection is started.
61     */
62    private String clientName;
63  
64    // ****************************** Initializer *******************************
65  
66    // ****************************** Constructors ******************************
67  
68    // ****************************** Inner Classes *****************************
69  
70    // ********************************* Methods ********************************
71  
72    // --- init -----------------------------------------------------------------
73  
74    // --- get&set --------------------------------------------------------------
75  
76    /**
77     * Returns the id of the proxy entry in the maven settings.
78     *
79     * @return the id of the proxy entry in the maven settings.
80     */
81    public String getId()
82    {
83      return this.id;
84    }
85  
86    /**
87     * Sets the id of the proxy entry in the maven settings.
88     *
89     * @param id the id of the proxy entry in the maven settings.
90     */
91    public void setId(final String id)
92    {
93      this.id = id;
94    }
95  
96    /**
97     * Returns the specified proxy host.
98     *
99     * @return the specified proxy host.
100    */
101   public String getHost()
102   {
103     return this.host;
104   }
105 
106   /**
107    * Sets the specified proxy host.
108    *
109    * @param host the specified proxy host.
110    */
111   public void setHost(final String host)
112   {
113     this.host = host;
114   }
115 
116   /**
117    * Returns the specified proxy port.
118    *
119    * @return the specified proxy port.
120    */
121   public int getPort()
122   {
123     return this.port;
124   }
125 
126   /**
127    * Sets the specified proxy port.
128    *
129    * @param port the specified proxy port.
130    */
131   public void setPort(final int port)
132   {
133     this.port = port;
134   }
135 
136   /**
137    * Returns the password to authenticate against the proxy.
138    *
139    * @return the password to authenticate against the proxy.
140    */
141   public String getPassword()
142   {
143     return this.password;
144   }
145 
146   /**
147    * Sets the password to authenticate against the proxy.
148    *
149    * @param password the password to authenticate against the proxy.
150    */
151   public void setPassword(final String password)
152   {
153     this.password = password;
154   }
155 
156   /**
157    * Returns the userName to authenticate against the proxy.
158    *
159    * @return the userName to authenticate against the proxy.
160    */
161   public String getUserName()
162   {
163     return this.userName;
164   }
165 
166   /**
167    * Sets the username to authenticate against the proxy.
168    *
169    * @param userName the username to authenticate against the proxy.
170    */
171   public void setUserName(final String userName)
172   {
173     this.userName = userName;
174   }
175 
176   /**
177    * Returns the windows NT-Domain the user uses to connect to the proxy.
178    *
179    * @return the windows NT-Domain the user uses to connect to the proxy.
180    */
181   public String getDomain()
182   {
183     return this.domain;
184   }
185 
186   /**
187    * Sets the windows NT-Domain the user uses to connect to the proxy.
188    *
189    * @param domain the windows NT-Domain the user uses to connect to the proxy.
190    */
191   public void setDomain(final String domain)
192   {
193     this.domain = domain;
194   }
195 
196   /**
197    * Returns the client name from which the connection is started.
198    *
199    * @return the client name from which the connection is started.
200    */
201   public String getClientName()
202   {
203     return this.clientName;
204   }
205 
206   /**
207    * Sets the client name from which the connection is started.
208    *
209    * @param clientName the client name from which the connection is started.
210    */
211   public void setClientName(final String clientName)
212   {
213     this.clientName = clientName;
214   }
215 
216   // --- business -------------------------------------------------------------
217 
218   // --- object basics --------------------------------------------------------
219 
220 }