refactoring for web authentication

This commit is contained in:
Shunji Makino 2015-10-23 15:04:18 +09:00
parent 5193d958cb
commit 93454ae1fe
7 changed files with 288 additions and 209 deletions

View file

@ -29,6 +29,7 @@ import org.codelibs.fess.es.cbean.WebAuthenticationCB;
import org.codelibs.fess.es.exbhv.WebAuthenticationBhv;
import org.codelibs.fess.es.exentity.WebAuthentication;
import org.dbflute.cbean.result.PagingResultBean;
import org.dbflute.optional.OptionalEntity;
public class WebAuthenticationService implements Serializable {
@ -57,17 +58,8 @@ public class WebAuthenticationService implements Serializable {
return webAuthenticationList;
}
public WebAuthentication getWebAuthentication(final Map<String, String> keys) {
final WebAuthentication webAuthentication = webAuthenticationBhv.selectEntity(cb -> {
cb.query().docMeta().setId_Equal(keys.get("id"));
setupEntityCondition(cb, keys);
}).orElse(null);//TODO
if (webAuthentication == null) {
// TODO exception?
return null;
}
return webAuthentication;
public OptionalEntity<WebAuthentication> getWebAuthentication(final String id) {
return webAuthenticationBhv.selectByPK(id);
}
public void store(final WebAuthentication webAuthentication) {

View file

@ -35,6 +35,7 @@ import org.codelibs.fess.es.exentity.WebAuthentication;
import org.codelibs.fess.es.exentity.WebConfig;
import org.codelibs.fess.helper.SystemHelper;
import org.codelibs.fess.util.ComponentUtil;
import org.dbflute.optional.OptionalEntity;
import org.lastaflute.web.Execute;
import org.lastaflute.web.callback.ActionRuntime;
import org.lastaflute.web.response.HtmlResponse;
@ -74,14 +75,14 @@ public class AdminWebauthenticationAction extends FessAdminAction {
// Search Execute
// ==============
@Execute
public HtmlResponse index(final WebAuthenticationSearchForm form) {
public HtmlResponse index(final SearchForm form) {
return asHtml(path_AdminWebauthentication_IndexJsp).renderWith(data -> {
searchPaging(data, form);
});
}
@Execute
public HtmlResponse list(final Integer pageNumber, final WebAuthenticationSearchForm form) {
public HtmlResponse list(final Integer pageNumber, final SearchForm form) {
webAuthenticationPager.setCurrentPageNumber(pageNumber);
return asHtml(path_AdminWebauthentication_IndexJsp).renderWith(data -> {
searchPaging(data, form);
@ -89,15 +90,15 @@ public class AdminWebauthenticationAction extends FessAdminAction {
}
@Execute
public HtmlResponse search(final WebAuthenticationSearchForm form) {
copyBeanToBean(form.searchParams, webAuthenticationPager, op -> op.exclude(Constants.PAGER_CONVERSION_RULE));
public HtmlResponse search(final SearchForm form) {
copyBeanToBean(form, webAuthenticationPager, op -> op.exclude(Constants.PAGER_CONVERSION_RULE));
return asHtml(path_AdminWebauthentication_IndexJsp).renderWith(data -> {
searchPaging(data, form);
});
}
@Execute
public HtmlResponse reset(final WebAuthenticationSearchForm form) {
public HtmlResponse reset(final SearchForm form) {
webAuthenticationPager.clear();
return asHtml(path_AdminWebauthentication_IndexJsp).renderWith(data -> {
searchPaging(data, form);
@ -105,17 +106,17 @@ public class AdminWebauthenticationAction extends FessAdminAction {
}
@Execute
public HtmlResponse back(final WebAuthenticationSearchForm form) {
public HtmlResponse back(final SearchForm form) {
return asHtml(path_AdminWebauthentication_IndexJsp).renderWith(data -> {
searchPaging(data, form);
});
}
protected void searchPaging(final RenderData data, final WebAuthenticationSearchForm form) {
protected void searchPaging(final RenderData data, final SearchForm form) {
data.register("webAuthenticationItems", webAuthenticationService.getWebAuthenticationList(webAuthenticationPager)); // page navi
data.register("displayCreateLink", !webConfigService.getAllWebConfigList(false, false, false, null).isEmpty());
// restore from pager
copyBeanToBean(webAuthenticationPager, form.searchParams, op -> op.exclude(Constants.PAGER_CONVERSION_RULE));
copyBeanToBean(webAuthenticationPager, form, op -> op.include("id"));
}
// ===================================================================================
@ -126,9 +127,43 @@ public class AdminWebauthenticationAction extends FessAdminAction {
// ----------
@Token(save = true, validate = false)
@Execute
public HtmlResponse createpage(final WebAuthenticationEditForm form) {
form.initialize();
form.crudMode = CrudMode.CREATE;
public HtmlResponse createpage() {
return asHtml(path_AdminWebauthentication_EditJsp).useForm(CreateForm.class, op -> {
op.setup(form -> {
form.initialize();
form.crudMode = CrudMode.CREATE;
});
}).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
});
}
@Token(save = true, validate = false)
@Execute
public HtmlResponse editpage(final int crudMode, final String id) {
return asHtml(path_AdminWebauthentication_EditJsp).useForm(EditForm.class, op -> {
op.setup(form -> {
webAuthenticationService.getWebAuthentication(id).ifPresent(entity -> {
copyBeanToBean(entity, form, copyOp -> {
copyOp.excludeNull();
});
}).orElse(() -> {
throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), toEditHtml());
});
form.crudMode = crudMode;
});
}).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
});
}
@Token(save = true, validate = false)
@Execute
public HtmlResponse createagain(final CreateForm form) {
verifyCrudMode(form.crudMode, CrudMode.CREATE);
validate(form, messages -> {}, toEditHtml());
return asHtml(path_AdminWebauthentication_EditJsp).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
@ -137,11 +172,9 @@ public class AdminWebauthenticationAction extends FessAdminAction {
@Token(save = true, validate = false)
@Execute
public HtmlResponse editpage(final int crudMode, final String id, final WebAuthenticationEditForm form) {
form.crudMode = crudMode;
form.id = id;
verifyCrudMode(form, CrudMode.EDIT);
loadWebAuthentication(form);
public HtmlResponse editagain(final EditForm form) {
verifyCrudMode(form.crudMode, CrudMode.EDIT);
validate(form, messages -> {}, toEditHtml());
return asHtml(path_AdminWebauthentication_EditJsp).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
@ -150,18 +183,15 @@ public class AdminWebauthenticationAction extends FessAdminAction {
@Token(save = true, validate = false)
@Execute
public HtmlResponse editagain(final WebAuthenticationEditForm form) {
return asHtml(path_AdminWebauthentication_EditJsp).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
});
}
@Token(save = true, validate = false)
@Execute
public HtmlResponse editfromconfirm(final WebAuthenticationEditForm form) {
public HtmlResponse editfromconfirm(final EditForm form) {
validate(form, messages -> {}, toEditHtml());
form.crudMode = CrudMode.EDIT;
loadWebAuthentication(form);
String id = form.id;
webAuthenticationService.getWebAuthentication(id).ifPresent(entity -> {
copyBeanToBean(entity, form, op -> {});
}).orElse(() -> {
throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), toEditHtml());
});
return asHtml(path_AdminWebauthentication_EditJsp).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
@ -170,12 +200,20 @@ public class AdminWebauthenticationAction extends FessAdminAction {
@Token(save = true, validate = false)
@Execute
public HtmlResponse deletepage(final int crudMode, final String id, final WebAuthenticationEditForm form) {
form.crudMode = crudMode;
form.id = id;
verifyCrudMode(form, CrudMode.DELETE);
loadWebAuthentication(form);
return asHtml(path_AdminWebauthentication_ConfirmJsp).renderWith(data -> {
public HtmlResponse deletepage(final int crudMode, final String id) {
verifyCrudMode(crudMode, CrudMode.DELETE);
return asHtml(path_AdminWebauthentication_ConfirmJsp).useForm(EditForm.class, op -> {
op.setup(form -> {
webAuthenticationService.getWebAuthentication(id).ifPresent(entity -> {
copyBeanToBean(entity, form, copyOp -> {
copyOp.excludeNull();
});
}).orElse(() -> {
throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), toEditHtml());
});
form.crudMode = crudMode;
});
}).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
});
@ -183,9 +221,15 @@ public class AdminWebauthenticationAction extends FessAdminAction {
@Token(save = true, validate = false)
@Execute
public HtmlResponse deletefromconfirm(final WebAuthenticationEditForm form) {
public HtmlResponse deletefromconfirm(final EditForm form) {
validate(form, messages -> {}, toEditHtml());
form.crudMode = CrudMode.DELETE;
loadWebAuthentication(form);
String id = form.id;
webAuthenticationService.getWebAuthentication(id).ifPresent(entity -> {
copyBeanToBean(entity, form, op -> {});
}).orElse(() -> {
throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), toEditHtml());
});
return asHtml(path_AdminWebauthentication_ConfirmJsp).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
@ -196,11 +240,30 @@ public class AdminWebauthenticationAction extends FessAdminAction {
// Confirm
// -------
@Execute
public HtmlResponse confirmpage(final int crudMode, final String id, final WebAuthenticationEditForm form) {
form.crudMode = crudMode;
form.id = id;
verifyCrudMode(form, CrudMode.CONFIRM);
loadWebAuthentication(form);
public HtmlResponse confirmpage(final int crudMode, final String id) {
verifyCrudMode(crudMode, CrudMode.CONFIRM);
return asHtml(path_AdminWebauthentication_ConfirmJsp).useForm(EditForm.class, op -> {
op.setup(form -> {
webAuthenticationService.getWebAuthentication(id).ifPresent(entity -> {
copyBeanToBean(entity, form, copyOp -> {
copyOp.excludeNull();
});
form.crudMode = crudMode;
}).orElse(() -> {
throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), toEditHtml());
});
});
}).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
});
}
@Token(save = false, validate = true, keep = true)
@Execute
public HtmlResponse confirmfromcreate(final CreateForm form) {
validate(form, messages -> {}, toEditHtml());
form.crudMode = CrudMode.CREATE;
return asHtml(path_AdminWebauthentication_ConfirmJsp).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
@ -209,18 +272,9 @@ public class AdminWebauthenticationAction extends FessAdminAction {
@Token(save = false, validate = true, keep = true)
@Execute
public HtmlResponse confirmfromcreate(final WebAuthenticationEditForm form) {
validate(form, messages -> {}, toEditHtml());
return asHtml(path_AdminWebauthentication_ConfirmJsp).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
});
}
@Token(save = false, validate = true, keep = true)
@Execute
public HtmlResponse confirmfromupdate(final WebAuthenticationEditForm form) {
public HtmlResponse confirmfromupdate(final EditForm form) {
validate(form, messages -> {}, toEditHtml());
form.crudMode = CrudMode.EDIT;
return asHtml(path_AdminWebauthentication_ConfirmJsp).renderWith(data -> {
registerProtocolSchemeItems(data);
registerWebConfigItems(data);
@ -232,66 +286,78 @@ public class AdminWebauthenticationAction extends FessAdminAction {
// -------------
@Token(save = false, validate = true)
@Execute
public HtmlResponse create(final WebAuthenticationEditForm form) {
public HtmlResponse create(final CreateForm form) {
verifyCrudMode(form.crudMode, CrudMode.CREATE);
validate(form, messages -> {}, toEditHtml());
webAuthenticationService.store(createWebAuthentication(form));
saveInfo(messages -> messages.addSuccessCrudCreateCrudTable(GLOBAL));
createWebAuthentication(form).ifPresent(entity -> {
copyBeanToBean(form, entity, op -> op.exclude(Constants.COMMON_CONVERSION_RULE));
webAuthenticationService.store(entity);
saveInfo(messages -> messages.addSuccessCrudCreateCrudTable(GLOBAL));
}).orElse(() -> {
throwValidationError(messages -> messages.addErrorsCrudFailedToCreateCrudTable(GLOBAL), toEditHtml());
});
return redirect(getClass());
}
@Token(save = false, validate = true)
@Execute
public HtmlResponse update(final WebAuthenticationEditForm form) {
public HtmlResponse update(final EditForm form) {
verifyCrudMode(form.crudMode, CrudMode.EDIT);
validate(form, messages -> {}, toEditHtml());
webAuthenticationService.store(createWebAuthentication(form));
saveInfo(messages -> messages.addSuccessCrudUpdateCrudTable(GLOBAL));
createWebAuthentication(form).ifPresent(entity -> {
copyBeanToBean(form, entity, op -> op.exclude(Constants.COMMON_CONVERSION_RULE));
webAuthenticationService.store(entity);
saveInfo(messages -> messages.addSuccessCrudUpdateCrudTable(GLOBAL));
}).orElse(() -> {
throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, form.id), toEditHtml());
});
return redirect(getClass());
}
@Execute
public HtmlResponse delete(final WebAuthenticationEditForm form) {
verifyCrudMode(form, CrudMode.DELETE);
webAuthenticationService.delete(getWebAuthentication(form));
saveInfo(messages -> messages.addSuccessCrudDeleteCrudTable(GLOBAL));
public HtmlResponse delete(final EditForm form) {
verifyCrudMode(form.crudMode, CrudMode.DELETE);
validate(form, messages -> {}, toEditHtml());
final String id = form.id;
webAuthenticationService.getWebAuthentication(id).ifPresent(entity -> {
webAuthenticationService.delete(entity);
saveInfo(messages -> messages.addSuccessCrudDeleteCrudTable(GLOBAL));
}).orElse(() -> {
throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), toEditHtml());
});
return redirect(getClass());
}
//===================================================================================
// Assist Logic
// ============
protected void loadWebAuthentication(final WebAuthenticationEditForm form) {
copyBeanToBean(getWebAuthentication(form), form, op -> op.exclude("crudMode"));
}
protected WebAuthentication getWebAuthentication(final WebAuthenticationEditForm form) {
final WebAuthentication webAuthentication = webAuthenticationService.getWebAuthentication(createKeyMap(form));
if (webAuthentication == null) {
throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, form.id), toEditHtml());
}
return webAuthentication;
}
protected WebAuthentication createWebAuthentication(final WebAuthenticationEditForm form) {
WebAuthentication webAuthentication;
protected OptionalEntity<WebAuthentication> createWebAuthentication(final CreateForm form) {
final String username = systemHelper.getUsername();
final long currentTime = systemHelper.getCurrentTimeAsLong();
if (form.crudMode == CrudMode.EDIT) {
webAuthentication = getWebAuthentication(form);
} else {
webAuthentication = new WebAuthentication();
webAuthentication.setCreatedBy(username);
webAuthentication.setCreatedTime(currentTime);
switch (form.crudMode) {
case CrudMode.CREATE:
if (form instanceof CreateForm) {
final WebAuthentication entity = new WebAuthentication();
entity.setCreatedBy(username);
entity.setCreatedTime(currentTime);
entity.setUpdatedBy(username);
entity.setUpdatedTime(currentTime);
return OptionalEntity.of(entity);
}
break;
case CrudMode.EDIT:
if (form instanceof EditForm) {
return webAuthenticationService.getWebAuthentication(((EditForm) form).id).map(entity -> {
entity.setUpdatedBy(username);
entity.setUpdatedTime(currentTime);
return entity;
});
}
break;
default:
break;
}
webAuthentication.setUpdatedBy(username);
webAuthentication.setUpdatedTime(currentTime);
copyBeanToBean(form, webAuthentication, op -> op.exclude(Constants.COMMON_CONVERSION_RULE));
return webAuthentication;
}
protected Map<String, String> createKeyMap(final WebAuthenticationEditForm form) {
final Map<String, String> keys = new HashMap<String, String>();
keys.put("id", form.id);
return keys;
return OptionalEntity.empty();
}
protected void registerProtocolSchemeItems(final RenderData data) {
@ -325,10 +391,10 @@ public class AdminWebauthenticationAction extends FessAdminAction {
// ===================================================================================
// Small Helper
// ============
protected void verifyCrudMode(final WebAuthenticationEditForm form, final int expectedMode) {
if (form.crudMode != expectedMode) {
protected void verifyCrudMode(final int crudMode, final int expectedMode) {
if (crudMode != expectedMode) {
throwValidationError(messages -> {
messages.addErrorsCrudInvalidMode(GLOBAL, String.valueOf(expectedMode), String.valueOf(form.crudMode));
messages.addErrorsCrudInvalidMode(GLOBAL, String.valueOf(expectedMode), String.valueOf(crudMode));
}, toEditHtml());
}
}

View file

@ -0,0 +1,78 @@
/*
* Copyright 2009-2015 the CodeLibs Project and the Others.
*
* Licensed 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.codelibs.fess.app.web.admin.webauthentication;
import java.io.Serializable;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.Size;
import org.codelibs.fess.app.web.CrudMode;
import org.codelibs.fess.util.ComponentUtil;
import org.lastaflute.web.validation.Required;
/**
* @author codelibs
* @author Shunji Makino
*/
public class CreateForm implements Serializable {
private static final long serialVersionUID = 1L;
public int crudMode;
@Size(max = 100)
public String hostname;
@Min(value = 0)
@Max(value = 2147483647)
public String port;
@Size(max = 100)
public String authRealm;
@Size(max = 10)
public String protocolScheme;
@Required
@Size(max = 100)
public String username;
@Size(max = 100)
public String password;
@Size(max = 1000)
public String parameters;
@Required
@Size(max = 1000)
public String webConfigId;
@Required
@Size(max = 255)
public String createdBy;
@Required
public Long createdTime;
public void initialize() {
crudMode = CrudMode.CREATE;
createdBy = "system";
createdTime = ComponentUtil.getSystemHelper().getCurrentTimeAsLong();
}
}

View file

@ -0,0 +1,43 @@
/*
* Copyright 2009-2015 the CodeLibs Project and the Others.
*
* Licensed 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.codelibs.fess.app.web.admin.webauthentication;
import javax.validation.constraints.Size;
import org.lastaflute.web.validation.Required;
/**
* @author codelibs
* @author Shunji Makino
*/
public class EditForm extends CreateForm {
private static final long serialVersionUID = 1L;
@Required
@Size(max = 1000)
public String id;
@Size(max = 255)
public String updatedBy;
public Long updatedTime;
@Required
public Integer versionNo;
}

View file

@ -17,16 +17,14 @@
package org.codelibs.fess.app.web.admin.webauthentication;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
/**
* @author codelibs
* @author Shunji Makino
*/
public class WebAuthenticationSearchForm implements Serializable {
public class SearchForm implements Serializable {
private static final long serialVersionUID = 1L;
public Map<String, String> searchParams = new HashMap<String, String>();
}
public String id;
}

View file

@ -1,98 +0,0 @@
/*
* Copyright 2009-2015 the CodeLibs Project and the Others.
*
* Licensed 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.codelibs.fess.app.web.admin.webauthentication;
import java.io.Serializable;
import org.codelibs.fess.util.ComponentUtil;
/**
* @author codelibs
* @author Shunji Makino
*/
public class WebAuthenticationEditForm implements Serializable {
private static final long serialVersionUID = 1L;
//@IntegerType
public int crudMode;
//@Required(target = "confirmfromupdate,update,delete")
//@Maxbytelength(maxbytelength = 1000)
public String id;
//@Maxbytelength(maxbytelength = 100)
public String hostname;
//@IntRange(min = -1, max = 2147483647)
public String port;
//@Maxbytelength(maxbytelength = 100)
public String authRealm;
//@Maxbytelength(maxbytelength = 10)
public String protocolScheme;
//@Required(target = "confirmfromcreate,create,confirmfromupdate,update,delete")
//@Maxbytelength(maxbytelength = 100)
public String username;
//@Maxbytelength(maxbytelength = 100)
public String password;
//@Maxbytelength(maxbytelength = 1000)
public String parameters;
//@Required(target = "confirmfromcreate,create,confirmfromupdate,update,delete")
//@Maxbytelength(maxbytelength = 1000)
public String webConfigId;
//@Required(target = "confirmfromupdate,update,delete")
//@Maxbytelength(maxbytelength = 255)
public String createdBy;
//@Required(target = "confirmfromupdate,update,delete")
//@LongType
public String createdTime;
//@Maxbytelength(maxbytelength = 255)
public String updatedBy;
//@LongType
public String updatedTime;
//@Required(target = "confirmfromupdate,update,delete")
//@IntegerType
public String versionNo;
public void initialize() {
id = null;
hostname = null;
port = null;
authRealm = null;
protocolScheme = null;
username = null;
password = null;
parameters = null;
webConfigId = null;
createdBy = "system";
createdTime = Long.toString(ComponentUtil.getSystemHelper().getCurrentTimeAsLong());
updatedBy = null;
updatedTime = null;
versionNo = null;
}
}

View file

@ -134,7 +134,7 @@
<%-- Box Footer --%>
<div class="box-footer">
<c:if test="${crudMode == 1}">
<input type="submit" class="btn" name="editagain" value="<la:message key="labels.web_authentication_button_back"/>" />
<input type="submit" class="btn" name="createagain" value="<la:message key="labels.web_authentication_button_back"/>" />
<input type="submit" class="btn btn-primary" name="create"
value="<la:message key="labels.web_authentication_button_create"/>"
/>