edu.internet2.middleware.grouper.ws.rest.group.WsRestAssignGrouperPrivilegesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of grouper-ws Show documentation
Show all versions of grouper-ws Show documentation
Internet2 Groups Management WS Core
/*******************************************************************************
* Copyright 2012 Internet2
*
* 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 edu.internet2.middleware.grouper.ws.rest.group;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.logging.Log;
import edu.internet2.middleware.grouper.util.GrouperUtil;
import edu.internet2.middleware.grouper.ws.coresoap.WsGroupLookup;
import edu.internet2.middleware.grouper.ws.coresoap.WsParam;
import edu.internet2.middleware.grouper.ws.coresoap.WsStemLookup;
import edu.internet2.middleware.grouper.ws.coresoap.WsSubjectLookup;
import edu.internet2.middleware.grouper.ws.rest.WsRequestBean;
import edu.internet2.middleware.grouper.ws.rest.method.GrouperRestHttpMethod;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
/**
*
* Class with data about assigning privileges for a subject and group
*
*
* @author mchyzer
*/
@ApiModel(description = "bean that will be the data from rest request for assigning grouper privileges
actAsSubjectLookup: If allowed to act as other users (e.g. if a UI uses the Grouper WS behind the scenes), specify the user to act as here
"
+ "
params: optional params for this request
"
+ "
wsGroupLookup: group to assign privilege
"
+ "
wsStemLookup: stem to assign privilege
")
public class WsRestAssignGrouperPrivilegesRequest implements WsRequestBean {
/** attribute names to return */
private String[] subjectAttributeNames;
/**
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return ToStringBuilder.reflectionToString(this);
}
/**
* T to replace existing members, F or blank to just change assignments. Only for allowed T
*/
private String replaceAllExisting;
/**
* T to replace existing members, F or blank to just change assignments. Only for allowed T
* @return replace all existing
*/
@ApiModelProperty(value = "T to replace existing members, F or blank to just change assignments. Only for allowed T", example = "T|F")
public String getReplaceAllExisting() {
return this.replaceAllExisting;
}
/**
*
* @param replaceAllExisting1
*/
public void setReplaceAllExisting(String replaceAllExisting1) {
this.replaceAllExisting = replaceAllExisting1;
}
/**
* logger
*/
@SuppressWarnings("unused")
private static final Log LOG = GrouperUtil.getLog(WsRestAssignGrouperPrivilegesRequest.class);
/**
* @see edu.internet2.middleware.grouper.ws.rest.WsRequestBean#retrieveRestHttpMethod()
*/
public GrouperRestHttpMethod retrieveRestHttpMethod() {
return GrouperRestHttpMethod.PUT;
}
/**
* T or F as to whether this privilege is being assigned or removed
*/
private String allowed;
/**
* version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
*/
private String clientVersion;
/**
* group to assign privilege
*/
private WsGroupLookup wsGroupLookup;
/**
* group to assign privilege
* @return group lookup
*/
public WsGroupLookup getWsGroupLookup() {
return this.wsGroupLookup;
}
/**
* group to assign privilege
* @param wsGroupLookup1
*/
public void setWsGroupLookup(WsGroupLookup wsGroupLookup1) {
this.wsGroupLookup = wsGroupLookup1;
}
/**
* stem to assign privilege to
*/
private WsStemLookup wsStemLookup;
/**
* stem to assign privilege
* @return stem lookup
*/
public WsStemLookup getWsStemLookup() {
return this.wsStemLookup;
}
/**
* group to assign privilege
* @param wsStemLookup1
*/
public void setWsStemLookup(WsStemLookup wsStemLookup1) {
this.wsStemLookup = wsStemLookup1;
}
/**
* privilegeType (e.g. "access" for groups and "naming" for stems)
*/
private String privilegeType;
/**
* (e.g. for groups: read, view, update, admin, optin, optout. e.g. for stems:
* stem, create)
*/
private String[] privilegeNames;
/**
*
*/
private String includeSubjectDetail;
/**
* T or F as for if group detail should be included
*/
private String includeGroupDetail;
/** subjects to assign to */
private WsSubjectLookup[] wsSubjectLookups;
/** who to act as if not the connecting user */
private WsSubjectLookup actAsSubjectLookup;
/** field */
private String txType;
/** field */
private WsParam[] params;
/**
* version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
* @return version
*/
@ApiModelProperty(value = "Version of the client (i.e. that the client was coded against)", example = "v2_6_001")
public String getClientVersion() {
return this.clientVersion;
}
/**
*
* @param clientVersion1
*/
public void setClientVersion(String clientVersion1) {
this.clientVersion = clientVersion1;
}
/**
* privilegeType (e.g. "access" for groups and "naming" for stems)
* @return type
*/
@ApiModelProperty(value = "Type of privilege, (e.g. access for groups and naming for stems)", example = "access")
public String getPrivilegeType() {
return this.privilegeType;
}
/**
* privilegeType (e.g. "access" for groups and "naming" for stems)
* @param privilegeType1
*/
public void setPrivilegeType(String privilegeType1) {
this.privilegeType = privilegeType1;
}
/**
* (e.g. for groups: read, view, update, admin, optin, optout. e.g. for stems:
* stem, create)
* @return name
*/
@ApiModelProperty(value = "privilege name", example = "for groups: read, view, update, admin, optin, optout. for stems stem, create")
public String[] getPrivilegeNames() {
return this.privilegeNames;
}
/**
* (e.g. for groups: read, view, update, admin, optin, optout. e.g. for stems:
* stem, create)
* @param privilegeNames1
*/
public void setPrivilegeNames(String[] privilegeNames1) {
this.privilegeNames = privilegeNames1;
}
/**
* T|F, for if the extended subject information should be
* returned (anything more than just the id)
* @return include detail
*/
@ApiModelProperty(value = "T|F, for if the extended subject information should be returned (anything more than just the id)", example = "T|F")
public String getIncludeSubjectDetail() {
return this.includeSubjectDetail;
}
/**
* T|F, for if the extended subject information should be
* returned (anything more than just the id)
* @param includeSubjectDetail1
*/
public void setIncludeSubjectDetail(String includeSubjectDetail1) {
this.includeSubjectDetail = includeSubjectDetail1;
}
/**
* T or F as for if group detail should be included
* @return T of F
*/
@ApiModelProperty(value = "T|F, for if the extended group information should be returned (anything more than just the id)", example = "T|F")
public String getIncludeGroupDetail() {
return this.includeGroupDetail;
}
/**
* T or F as for if group detail should be included
* @param includeGroupDetail1
*/
public void setIncludeGroupDetail(String includeGroupDetail1) {
this.includeGroupDetail = includeGroupDetail1;
}
/**
* T or F as to whether this privilege is being assigned or removed
* @return allowed
*/
@ApiModelProperty(value = "T or F as to whether this privilege is being assigned or removed", example = "T|F")
public String getAllowed() {
return this.allowed;
}
/**
* T or F as to whether this privilege is being assigned or removed
* @param allowed1
*/
public void setAllowed(String allowed1) {
this.allowed = allowed1;
}
/**
* subjects to assign to
* @return the subjectLookups
*/
public WsSubjectLookup[] getWsSubjectLookups() {
return this.wsSubjectLookups;
}
/**
* subjects to assign to
* @param subjectLookups1 the subjectLookups to set
*/
public void setWsSubjectLookups(WsSubjectLookup[] subjectLookups1) {
this.wsSubjectLookups = subjectLookups1;
}
/**
* who to act as if not the connecting user
* @return the actAsSubjectLookup
*/
public WsSubjectLookup getActAsSubjectLookup() {
return this.actAsSubjectLookup;
}
/**
* who to act as if not the connecting user
* @param actAsSubjectLookup1 the actAsSubjectLookup to set
*/
public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1) {
this.actAsSubjectLookup = actAsSubjectLookup1;
}
/**
* @return the subjectAttributeNames
*/
@ApiModelProperty(value = "are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent", example = "LastName")
public String[] getSubjectAttributeNames() {
return this.subjectAttributeNames;
}
/**
* @param subjectAttributeNames1 the subjectAttributeNames to set
*/
public void setSubjectAttributeNames(String[] subjectAttributeNames1) {
this.subjectAttributeNames = subjectAttributeNames1;
}
/**
* @return the txType
*/
@ApiModelProperty(value = "is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.", example = "READ_WRITE_NEW")
public String getTxType() {
return this.txType;
}
/**
* @param txType1 the txType to set
*/
public void setTxType(String txType1) {
this.txType = txType1;
}
/**
* @return the params
*/
public WsParam[] getParams() {
return this.params;
}
/**
* @param params1 the params to set
*/
public void setParams(WsParam[] params1) {
this.params = params1;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy