Author: ngn
Date: Sun Mar 7 09:42:36 2010
New Revision: 919954
URL: http://svn.apache.org/viewvc?rev=919954&view=rev
Log:
Adding factory for creating users, especially useful in OSGi environment where
access to BaseUser is inhibited (FTPSERVER-336)
Added:
mina/ftpserver/branches/1.0.x/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
mina/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
Added:
mina/ftpserver/branches/1.0.x/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
URL:
http://svn.apache.org/viewvc/mina/ftpserver/branches/1.0.x/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java?rev=919954&view=auto
==============================================================================
---
mina/ftpserver/branches/1.0.x/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
(added)
+++
mina/ftpserver/branches/1.0.x/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
Sun Mar 7 09:42:36 2010
@@ -0,0 +1,159 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.ftpserver.usermanager;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.ftpserver.ftplet.Authority;
+import org.apache.ftpserver.ftplet.User;
+import org.apache.ftpserver.usermanager.impl.BaseUser;
+
+/**
+ * Factory for {...@link User} instances.
+ *
+ * @author <a href="http://mina.apache.org";>Apache MINA Project</a>
+ */
+public class UserFactory {
+
+ private String name = null;
+
+ private String password = null;
+
+ private int maxIdleTimeSec = 0; // no limit
+
+ private String homeDir = null;
+
+ private boolean isEnabled = true;
+
+ private List<Authority> authorities = new ArrayList<Authority>();
+
+ /**
+ * Creates a user based on the configuration set on the factory
+ * @return The created user
+ */
+ public User createUser() {
+ BaseUser user = new BaseUser();
+ user.setName(name);
+ user.setPassword(password);
+ user.setHomeDirectory(homeDir);
+ user.setEnabled(isEnabled);
+ user.setAuthorities(authorities);
+ user.setMaxIdleTime(maxIdleTimeSec);
+
+ return user;
+ }
+
+ /**
+ * Get the user name for users created by this factory
+ * @return The user name
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Set the user name for users created by this factory
+ * @param name The user name
+ */
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Get the password for users created by this factory
+ * @return The password
+ */
+ public String getPassword() {
+ return password;
+ }
+
+ /**
+ * Set the user name for users created by this factory
+ * @param password The password
+ */
+ public void setPassword(String password) {
+ this.password = password;
+ }
+
+ /**
+ * Get the max idle time for users created by this factory
+ * @return The max idle time in seconds
+ */
+ public int getMaxIdleTime() {
+ return maxIdleTimeSec;
+ }
+
+ /**
+ * Set the user name for users created by this factory
+ * @param maxIdleTimeSec The max idle time in seconds
+ */
+ public void setMaxIdleTime(int maxIdleTimeSec) {
+ this.maxIdleTimeSec = maxIdleTimeSec;
+ }
+
+ /**
+ * Get the home directory for users created by this factory
+ * @return The home directory path
+ */
+ public String getHomeDirectory() {
+ return homeDir;
+ }
+
+ /**
+ * Set the user name for users created by this factory
+ * @param homeDir The home directory path
+ */
+ public void setHomeDirectory(String homeDir) {
+ this.homeDir = homeDir;
+ }
+
+ /**
+ * Get the enabled status for users created by this factory
+ * @return true if the user is enabled (allowed to log in)
+ */
+ public boolean isEnabled() {
+ return isEnabled;
+ }
+
+ /**
+ * Get the enabled status for users created by this factory
+ * @param isEnabled true if the user should be enabled (allowed to log
in)
+ */
+ public void setEnabled(boolean isEnabled) {
+ this.isEnabled = isEnabled;
+ }
+
+ /**
+ * Get the authorities for users created by this factory
+ * @return The authorities
+ */
+ public List<? extends Authority> getAuthorities() {
+ return authorities;
+ }
+
+ /**
+ * Set the authorities for users created by this factory
+ * @param authorities The authorities
+ */
+ public void setAuthorities(List<Authority> authorities) {
+ this.authorities = authorities;
+ }
+}
\ No newline at end of file
Added:
mina/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
URL:
http://svn.apache.org/viewvc/mina/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java?rev=919954&view=auto
==============================================================================
---
mina/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
(added)
+++
mina/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
Sun Mar 7 09:42:36 2010
@@ -0,0 +1,159 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.ftpserver.usermanager;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.ftpserver.ftplet.Authority;
+import org.apache.ftpserver.ftplet.User;
+import org.apache.ftpserver.usermanager.impl.BaseUser;
+
+/**
+ * Factory for {...@link User} instances.
+ *
+ * @author <a href="http://mina.apache.org";>Apache MINA Project</a>
+ */
+public class UserFactory {
+
+ private String name = null;
+
+ private String password = null;
+
+ private int maxIdleTimeSec = 0; // no limit
+
+ private String homeDir = null;
+
+ private boolean isEnabled = true;
+
+ private List<Authority> authorities = new ArrayList<Authority>();
+
+ /**
+ * Creates a user based on the configuration set on the factory
+ * @return The created user
+ */
+ public User createUser() {
+ BaseUser user = new BaseUser();
+ user.setName(name);
+ user.setPassword(password);
+ user.setHomeDirectory(homeDir);
+ user.setEnabled(isEnabled);
+ user.setAuthorities(authorities);
+ user.setMaxIdleTime(maxIdleTimeSec);
+
+ return user;
+ }
+
+ /**
+ * Get the user name for users created by this factory
+ * @return The user name
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Set the user name for users created by this factory
+ * @param name The user name
+ */
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Get the password for users created by this factory
+ * @return The password
+ */
+ public String getPassword() {
+ return password;
+ }
+
+ /**
+ * Set the user name for users created by this factory
+ * @param password The password
+ */
+ public void setPassword(String password) {
+ this.password = password;
+ }
+
+ /**
+ * Get the max idle time for users created by this factory
+ * @return The max idle time in seconds
+ */
+ public int getMaxIdleTime() {
+ return maxIdleTimeSec;
+ }
+
+ /**
+ * Set the user name for users created by this factory
+ * @param maxIdleTimeSec The max idle time in seconds
+ */
+ public void setMaxIdleTime(int maxIdleTimeSec) {
+ this.maxIdleTimeSec = maxIdleTimeSec;
+ }
+
+ /**
+ * Get the home directory for users created by this factory
+ * @return The home directory path
+ */
+ public String getHomeDirectory() {
+ return homeDir;
+ }
+
+ /**
+ * Set the user name for users created by this factory
+ * @param homeDir The home directory path
+ */
+ public void setHomeDirectory(String homeDir) {
+ this.homeDir = homeDir;
+ }
+
+ /**
+ * Get the enabled status for users created by this factory
+ * @return true if the user is enabled (allowed to log in)
+ */
+ public boolean isEnabled() {
+ return isEnabled;
+ }
+
+ /**
+ * Get the enabled status for users created by this factory
+ * @param isEnabled true if the user should be enabled (allowed to log
in)
+ */
+ public void setEnabled(boolean isEnabled) {
+ this.isEnabled = isEnabled;
+ }
+
+ /**
+ * Get the authorities for users created by this factory
+ * @return The authorities
+ */
+ public List<? extends Authority> getAuthorities() {
+ return authorities;
+ }
+
+ /**
+ * Set the authorities for users created by this factory
+ * @param authorities The authorities
+ */
+ public void setAuthorities(List<Authority> authorities) {
+ this.authorities = authorities;
+ }
+}
\ No newline at end of file
