OSGI Archives - Sourced Code

Send Out Emails with AEM Servlet

briankasingli — Fri, 21 Jan 2022 03:31:31 +0000

In this article, we will be setting up the local AEM author developer’s environment to send out an email utilizing the Day CQ Mail Service. This article includes code snippets to a Sling Servlet that will be used to send out the email.

We will be using a Google Gmail account as the SMTP Mail Server in this article. To learn how to set up your Google Gmail account as the SMTP server, click here.

1. Configure the Day CQ Mail Service

a. Visit http://localhost:4502/system/console/configMgr/com.day.cq.mailer.DefaultMailService

b. Include the configurations below:
Google SMTP Configurations
SMTP server hostname: smtp.gmail.com
SMTP server port: 465, 25 or 587 (test in that order)
SMTP user: @@YOUR_EMAIL_ADDRESS@@
SMTP from emai: @@YOUR_EMAIL_ADDRESS@@
SMTP password: @@YOUR_PASSWORD@@
SMTP TLS/SSL: true

To automate this configuration, you can run a Curl command like the example below. But please be aware, you must use your own Google Gmail account.

To update the Curl command below, use this tool here, Tool: Generate Curl Command to Update OSGI Configurations

curl -u admin:admin 'http://localhost:4502/system/console/configMgr/com.day.cq.mailer.DefaultMailService' --data-raw 'apply=true&action=ajaxConfigManager&%24location=&smtp.host=smtp.gmail.com&smtp.port=587&smtp.user=contact@sourcedcode.com&smtp.password=p4ssw0rd&from.address=contact@sourcedcode.com&smtp.ssl=true&propertylist=smtp.host%2Csmtp.port%2Csmtp.user%2Csmtp.password%2Cfrom.address%2Csmtp.ssl'

2. Create the SendEmailServletExample AEM Servlet

Create a Java class named, SendEmailServletExample.java, copy and paste the code below, replace line:44 with your own email, and then use your Java Maven skills to build the servlet in AEM.

Once when the SendEmailServletExample.java is built into AEM, visit http://localhost:4502/bin/sendemail,

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

package com.sourcedcode.core.servlet;

import com.day.cq.mailer.MessageGateway;
import com.day.cq.mailer.MessageGatewayService;
import org.apache.commons.mail.Email;
import org.apache.commons.mail.EmailException;
import org.apache.commons.mail.HtmlEmail;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
import org.json.JSONException;
import org.json.JSONObject;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.Servlet;
import java.io.IOException;

import static org.apache.sling.api.servlets.ServletResolverConstants.SLING_SERVLET_PATHS;

@Component(
service = { Servlet.class },
property = {
SLING_SERVLET_PATHS + "=/bin/sendemail"
}
)
public class SendEmailServletExample extends SlingAllMethodsServlet {

private static Logger log = LoggerFactory.getLogger(SendEmailServletExample.class);

@Reference
private MessageGatewayService messageGatewayService;

@Override
protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) throws IOException {
JSONObject jsonResponse = new JSONObject();
boolean sent = false;
try {
String[] recipients = { "contact@sourcedcode.com" };
sendEmail("This is an test email",
"This is the email body", recipients);
response.setStatus(200);
sent = true;
} catch (EmailException e) {
response.setStatus(500);
}
try {
jsonResponse.put("result", sent ? "done" : "something went wrong");
} catch (JSONException e) {
e.printStackTrace();
}
response.getWriter().write(jsonResponse.toString());
}

private void sendEmail(String subjectLine, String msgBody, String[] recipients) throws EmailException {
Email email = new HtmlEmail();
for (String recipient : recipients) {
email.addTo(recipient, recipient);
}
email.setSubject(subjectLine);
email.setMsg(msgBody);
MessageGateway<Email> messageGateway = messageGatewayService.getGateway(HtmlEmail.class);
if (messageGateway != null) {
log.debug("sending out email");
messageGateway.send((Email) email);
} else {
log.error("The message gateway could not be retrieved.");
}
}
}

The post Send Out Emails with AEM Servlet appeared first on Sourced Code.

Get Cookie Example of AEM Servlet and Sling Model

briankasingli — Wed, 19 Jan 2022 04:58:31 +0000

In this short article, we will show two code examples; for example, one will be showcasing how cookies values can be accessed for an AEM Servlet, and for example two, Sling Model.

1. AEM Servlet Get Cookie Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

package com.sourcedcode.core.servlet;

import com.cat.wcm.core.util.JSONObject;
import org.apache.commons.lang.StringUtils;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
import org.osgi.service.component.annotations.Component;

import javax.servlet.Servlet;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

import static org.apache.sling.api.servlets.ServletResolverConstants.SLING_SERVLET_PATHS;

@Component(
service = { Servlet.class },
property = {
SLING_SERVLET_PATHS + "=/bin/getCookieExample"
}
)
public class GetCookieServletExample extends SlingAllMethodsServlet {

@Override
protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) throws IOException {
Cookie myCookie = getCookie(request, "myCookie");
String myCookieValue = "";
if (myCookie != null && !myCookie.getValue().isBlank()) {
myCookieValue = myCookie.getValue();
}

// server response
response.setStatus(200);
response.setContentType("application/json");

JSONObject jsonResponse = new JSONObject();
jsonResponse.put("myCookie", myCookieValue);
response.getWriter().write(jsonResponse.toString());
}

// extracted helper method
private Cookie getCookie(HttpServletRequest request, String cookieName) {
if (StringUtils.isBlank(cookieName)) {
return null;
} else {
Cookie[] cookies = request.getCookies();
if (cookies == null) {
return null;
} else {
if (cookies.length > 0) {
Cookie[] var3 = cookies;
int var4 = cookies.length;
for(int var5 = 0; var5 < var4; ++var5) {
Cookie cookie = var3[var5];
if (StringUtils.equals(cookieName, cookie.getName())) {
return cookie;
}
}
}
return null;
}
}
}
}

2. Sling Model Get Cookie Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

package com.sourcedcode.models.pages.page;

import org.apache.commons.lang.StringUtils;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.DefaultInjectionStrategy;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.injectorspecific.SlingObject;

import javax.annotation.PostConstruct;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;

@Model(
adaptables = {SlingHttpServletRequest.class, Resource.class},
defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL)
public class ExampleModel {

@SlingObject
protected SlingHttpServletRequest request;

@PostConstruct
private void init() {
Cookie myCookie = getCookie(request, "myCookie");
String myCookieValue = "";
if (myCookie != null && !myCookie.getValue().isBlank()) {
myCookieValue = myCookie.getValue();
}
}

// extracted helper method
private Cookie getCookie(HttpServletRequest request, String cookieName) {
if (StringUtils.isBlank(cookieName)) {
return null;
} else {
Cookie[] cookies = request.getCookies();
if (cookies == null) {
return null;
} else {
if (cookies.length > 0) {
Cookie[] var3 = cookies;
int var4 = cookies.length;
for(int var5 = 0; var5 < var4; ++var5) {
Cookie cookie = var3[var5];
if (StringUtils.equals(cookieName, cookie.getName())) {
return cookie;
}
}
}
return null;
}
}
}
}

The post Get Cookie Example of AEM Servlet and Sling Model appeared first on Sourced Code.

AEM inheritedpageproperties with Sightly, JSP, OSGI Bundle

briankasingli — Sun, 20 Sep 2020 17:18:31 +0000

inheritedpageproperties helps you retrieve a parent property from parent pages. Inherited page properties utilises com.day.cq.commons.inherit.HierarchyNodeInheritanceValueMap, where the search is made on the page hierarchy, upwards; searching children of the page nodes (components) are not included. Inherited page properties can be retrieved in multiple ways, where this article will only focus on 3 ways.

In this article, we will go through the 3 different ways in how we can retrieve inherited page properties.

How does this work?
inheritedPageProperties with Sightly
inheritedPageProperties with JSP
inheritedPageProperties with OSGI Bundle, Java Backend

How does this work?

An InheritanceValueMap for a given Resource that will inherit values from ancestral pages.
For example, given: /content/parent/page/jcr:content/footer/image/@width, the HierarchyNodeInheritanceValueMap will search for a footer/image/@width property in:

look up one: /content/parent/currentPage/jcr:content/footer/image/@width
look up two: /content/parent/jcr:content/footer/image/@width
look up three: /content/jcr:content/footer/image/@width

1. inheritedPageProperties with Sightly

Sightly offers a plethora of AEM Global objects, and one of them notably is the “inheritedPageProperties”. Utilising the inheritedPageProperties global object, we can use dot or square bracket notation to access the interited page property value.

1
2
3
4

${inheritedPageProperties.myCustomProperty}
${inheritedPageProperties['myCustomProperty']}
${inheritedPageProperties.jcr:title}
${inheritedPageProperties['jcr:title']}

2. inheritedPageProperties with JSP

Utilising the JSP include, /libs/foundation/global.jsp (purpose of retreiving the currentPage AEM global object), we can make use of the HierarchyNodeInheritanceValueMap.class, and currentPage resource to initialise the InheritanceValueMap.class object. Next, calling the method getInherited(String name, Class type), we are able to get the inherited page property.

1
2
3
4
5
6
7
8
9
10
11

<%@include file="/libs/foundation/global.jsp"%>
<%@ page import="com.day.cq.commons.inherit.InheritanceValueMap" %>
<%@ page import="com.day.cq.commons.inherit.HierarchyNodeInheritanceValueMap" %>

<%
InheritanceValueMap ivm = new HierarchyNodeInheritanceValueMap(currentPage.getContentResource());
String inheritedValueMyCustomProperty = ivm.getInherited("myCustomerProperty", String.class);
String inheritedValueJcrTitle = ivm.getInherited("jcr:title", String.class);
%>
inheritedValueMyCustomProperty = <%= inheritedValueMyCustomProperty %>
inheritedValueJcrTitle = <%= inheritedValueJcrTitle %>

3. inheritedPageProperties with OSGI Bundle, Java Backend

Similar to the JSP implementation above, we can make use of the HierarchyNodeInheritanceValueMap.class, and currentPage resource to initialise the InheritanceValueMap.class object. Next, calling the method getInherited(String name, Class type), we are able to get the inherited page property.

1
2
3
4
5
6
7
8
9

import com.day.cq.commons.inherit.InheritanceValueMap;
import com.day.cq.commons.inherit.HierarchyNodeInheritanceValueMap;

@ScriptVariable
private Page currentPage;
...
InheritanceValueMap ivm = new HierarchyNodeInheritanceValueMap(currentPage.getContentResource());
String inheritedValueMyCustomProperty = ivm.getInherited("myCustomerProperty", String.class);
String inheritedValueJcrTitle = ivm.getInherited("jcr:title", String.class);

The post AEM inheritedpageproperties with Sightly, JSP, OSGI Bundle appeared first on Sourced Code.

How to Enable Configuration for OSGI Components with R6

briankasingli — Sat, 06 Jun 2020 20:34:05 +0000

Adding configuration to OSGi Component(s) is as simple as annotating your class with @Designate(ocd=””) annotation with the “ocd” property, and to make the @Activate method accepts an config param; as indicated below:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

// /com/sourcedcode/services/impl/MyserviceImpl.java
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.metatype.annotations.Designate;

@Component(service = MyService.class, immediate = true)
@Designate(ocd = SourcedCodeSiteSettingsConfig.class)
public class MyserviceImpl extends MyService {
@Activate
protected void activate(SourcedCodeSiteSettingsConfig config) {
// do something
// String name = config.name();
}
}

The “ocd” property must be set with a configuration interface class that is annotated with @ObjectClassDefinition; the annotated interface class can be an imported Java interface class or inner Java interface class.

Once the @Designate annotation on the OSGI Component’s class and the @ObjectClassDefinition configuration interface are configured, the OSGI Component(s) will have enabled the configuration successfully; you should be able to find the configuration in the OSGI Apache Felix Console, under http://localhost:4502/system/console/configMgr.

Quick Links with Code Samples:
This article will highlight two different ways to enable configuration to your OSGI Component(s).

Imported Class – Enable OSGI Component’s Configuration Implementation
Inner Class – Enable OSGI Component’s Configuration Implementation

What is the @ObjectClassDefinition annotation?

The configuration interface is annotated with @ObjectClassDefinition where properties can be passed into the @ObjectClassDefinition annotation. The most common properties are @ObjectClassDefinition(name=””, description=””). The “name” property will be used as the title of the configuration popup within the OSGI Felix console, while the description property is used for the “description” of the popup.

1
2
3
4
5
6
7
8
9
10
11
12
13

// Example:
package com.sourcedcode.core.services;

import org.osgi.service.metatype.annotations.ObjectClassDefinition;

@ObjectClassDefinition(name = "SourcedCode - Site Settings Configuration",
description = "dialog description"
)
public @interface SourcedCodeSiteSettingsConfigExample {
// config1 @AttributeDefinition()
// config2 @AttributeDefinition()
// config3 @AttributeDefinition()
}

What is the @AttributeDefinition annotation?

Declaration of the @AttributeDefinition annotations defines each configuration by identifying the type, the configuration reference name, config name and description.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Note!
To wrap your head around some of the essentials of @AttributeDefinition, checkout this blog article : OSGI R6 Configuration @AttributeDefinition Essentials Reference Guide.

1. Imported Class – Defining OSGI Component’s Configuration with Configuration Interface

The title of this section speaks for itself. The examples below "Step A" example provides sample code of a configuration interface class that is prepared to be imported OSGI Service Component, indicated in "Step B". This class have one responsibility, and its to provide the definition of the OSGI Component’s configuration interface.

Step A. Defining the annotated Configuration Interface

Isolated configuration interface class that prepared to be imported and referenced by the OSGI Service Component.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

package com.sourcedcode.core.services;

import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.AttributeType;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;
import org.osgi.service.metatype.annotations.Option;

@ObjectClassDefinition(name = "SourcedCode - Site Settings Configuration",
description = "dialog description")
public @interface SourcedCodeSiteSettingsConfig {

@AttributeDefinition(
name = "String Label",
description = "String Config Example Description",
type = AttributeType.STRING)
String config_string_example() default "Default String";

@AttributeDefinition(
name = "String[] Label",
description = "String[] Config Example Description",
type = AttributeType.STRING)
String[] config_string_array_example() default {"item1", "item2"};

@AttributeDefinition(
name = "Long Label",
description = "Long Config Example Description",
type = AttributeType.LONG)
long config_long_example() default 0L;

@AttributeDefinition(
name = "int Label",
description = "innt Config Example Description",
type = AttributeType.INTEGER)
int config_number_example() default 0;

@AttributeDefinition(
name = "Short Label",
description = "Short Config Example Description",
type = AttributeType.SHORT)
short config_short_example() default 0;

@AttributeDefinition(
name = "Char Label",
description = "Char Config Example Description",
type = AttributeType.CHARACTER)
char config_char_example() default 0;

@AttributeDefinition(
name = "Byte Label",
description = "Byte Config Example Description",
type = AttributeType.BYTE)
byte config_byte_example() default 0;

@AttributeDefinition(
name = "Double Label",
description = "Double Config Example Description",
type = AttributeType.DOUBLE)
double config_double_example() default 0;

@AttributeDefinition(
name = "Float Label",
description = "Float Config Example Description",
type = AttributeType.FLOAT)
float config_float_example() default 0;

@AttributeDefinition(
name = "Boolean Label",
description = "Boolean Config Example Description",
type = AttributeType.BOOLEAN)
boolean config_boolean_example() default true;

@AttributeDefinition(
name = "Password Label",
description = "Password Config Example Description",
type = AttributeType.PASSWORD)
String config_password_config_example() default "";

@AttributeDefinition(
name = "Dropdown Label",
description = "Dropdown Config Example Description",
options = {
@Option(label = "PRODUCTION", value = "PRODUCTION"),
@Option(label = "STAGING", value = "STAGING"),
@Option(label = "UAT", value = "UAT"),
@Option(label = "QA", value = "QA"),
@Option(label = "DEVELOP", value = "DEVELOP")
}
)
String config_dropdown_example() default "DEVELOP";
}

Step B. Consuming the Configuration Interface by Imported Class

To use the configuration interface within our OSGI service component, we would need to annotation our service class with @Designate, with the ocd param pointing to the imported configuration interface class. Next, it would be as simple as setting up the initial @Activate method.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

package com.sourcedcode.core.services;

import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.metatype.annotations.Designate;
import com.sourcedcode.core.services.SourcedCodeSiteSettingsConfig;

@Component(service = SourcedCodeSiteSettingsService.class, immediate = true)
@Designate(ocd = SourcedCodeSiteSettingsConfig.class)
public class SourcedCodeSiteSettingsService {
private String config_string_example;
private String[] config_string_array_example;
private long config_long_example;
private int config_number_example;
private short config_short_example;
private char config_char_example;
private byte config_byte_example;
private double config_double_example;
private float config_float_example;
private Boolean config_boolean_example;
private String config_password_getConfig_example;
private String config_dropdown_example;

@Activate
protected void activate(SourcedCodeSiteSettingsConfig config) {
this.config_string_example = config.config_string_example();
this.config_string_array_example = config.config_string_array_example();
this.config_long_example = config.config_long_example();
this.config_number_example = config.config_number_example();
this.config_short_example = config.config_short_example();
this.config_char_example = config.config_char_example();
this.config_byte_example = config.config_byte_example();
this.config_double_example = config.config_double_example();
this.config_float_example = config.config_float_example();
this.config_boolean_example = config.config_boolean_example();
this.config_password_getConfig_example = config.config_password_config_example();
this.config_dropdown_example = config.config_dropdown_example();
}
}

Outcome Explained:
The outcome of the OSGI Service and Configuration will result in an editable configuration within the OSGI Apache Felix Console.

2. Inner Class – Defining OSGI Component’s Configuration with Configuration Interface

You can also define the annotated @ObjectClassDefinition interface as an inner class as shown below. To use the inner class configuration interface within our OSGI service, we would need to annotation our service class with @Designate, with the ocd param pointing to the inner interface class. Next, it would be as simple as setting up the initial @Activate method.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

package com.sourcedcode.core.services.impl;

import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.metatype.annotations.*;

@Component(service = SourcedCodeSiteSettingsServiceInlineExample.class, immediate = true)
@Designate(ocd = SourcedCodeSiteSettingsServiceInlineExample.SourcedCodeSiteSettingsConfig.class)
public class SourcedCodeSiteSettingsServiceInlineExample {

@ObjectClassDefinition(name = "SourcedCode - Site Settings Configuration",
description = "dialog description")
protected @interface SourcedCodeSiteSettingsConfig {

@AttributeDefinition(
name = "String Label",
description = "String Config Example Description",
type = AttributeType.STRING)
String config_string_example() default "Default String";

@AttributeDefinition(
name = "String[] Label",
description = "String[] Config Example Description",
type = AttributeType.STRING)
String[] config_string_array_example() default {"item1", "item2"};

@AttributeDefinition(
name = "Long Label",
description = "Long Config Example Description",
type = AttributeType.LONG)
long config_long_example() default 0L;
}

@Activate
protected void activate(SourcedCodeSiteSettingsConfig config) {

}
}

Thoughts…

I typically try my best to keep the configuration interface decoupled with OSGi components. This promotes better readability and maintainability. I would recommend you to stick with the Single Responsibility Principle; to separate concerns.

Note!
@AttributeDefinitions are the underlying formatting of how each OSGI configuration interaces are put together. If you wish to learn more about this topic, checkout this article: OSGI R6 Configuration @AttributeDefinition Essentials Reference Guide.

The post How to Enable Configuration for OSGI Components with R6 appeared first on Sourced Code.

OSGI R6 Configuration @AttributeDefinition Essentials Reference Guide

briankasingli — Wed, 03 Jun 2020 17:52:00 +0000

When defining any OSGI component’s configuration its standard practice to use Declarative Services; these configurations can be edited in the OSGI Apache Felix Console. This can be done by creating a class interface with the annotated @ObjectClassDefinition, which includes a determined list of rules as @AttributeDefinition items.

The @AttributeDefinition defines the supporting configuration for a given OSGI component’s configuration. It allows you to set data types and default values for each given configuration. When an admin user interacts with the Felix console, how the @AttributeDefinition is defined will determine the look and feel of each of the input fields are presented.

Quick Links

@AttributeDefinition Essential Parameters Explained
Attribute Types – References
How to Enable Configuration for OSGI Components

Attribute Types – References

String Attribute Type
String[] Attribute Type
Long Attribute Type
int Attribute Type
Short Attribute Type
Char Attribute Type
byte Attribute Type
Double Attribute Type
Float Attribute Type
Boolean Attribute Type
Password Attribute Type
Options Attribute Type

@AttributeDefinition Essential Parameters Explained

As we know, the most basic way to define a configuration will be to utilise the annotation @AttributeDefinition. Let’s explore the essential configurations.

The @AttributeDefinition annotation accepts parameters as such:

line 2: name: defines the human read-able label
line 3: description: description for the attribute configuration.
line 4: type: definition of the attribute’s data type.
line 6: : definition of the attribute’s data type
line 6: name_of_conf_reference: configuration’s reference id : name.of.conf.reference

line 7: []: multifield (multi data set) is supported.

1
2
3
4
5
6
7

@AttributeDefinition(
name=""
description=""
type=""
}
name_of_conf_reference() default "";
// [] name_of_conf_reference_list() default "";

Explained:
Illustrating how the label, description, and the configuration reference shows up on the OSGI Apache Felix console.

Attribute Types

With the understanding of how the @AttributeDefinition Essential Parameters are used, we can go ahead to utilise and to familiarize ourselves with the supported essential data attribute types; most of the basic attributes are covered below:

String Attribute Type
String[] Attribute Type
Long Attribute Type
int Attribute Type
Short Attribute Type
Char Attribute Type
byte Attribute Type
Float Attribute Type
Double Attribute Type
Boolean Attribute Type
Password Attribute Type
Options Attribute Type

1. String Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "String Label",
description = "String Config Example Description",
type = AttributeType.STRING)
String config_string_example() default "Default String";

2. String[] Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "String[] Label",
description = "String[] Config Example Description",
type = AttributeType.STRING)
String[] config_string_array_example() default {"item1", "item2"};

Explained:
Illustrating how the multi-fields shows up on the OSGI Felix console.

Note:
Configuration can be set as multifield can be enabled without much effort, simply change the attribute type to an list type, shown in the #2. String[] Attribute Type example.

3. Long Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "Long Label",
description = "Long Config Example Description",
type = AttributeType.LONG)
long config_long_example() default 0L;

4. int Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "int Label",
description = "innt Config Example Description",
type = AttributeType.INTEGER)
int config_number_example() default 0;

5. Short Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "Short Label",
description = "Short Config Example Description",
type = AttributeType.SHORT)
short config_short_example() default 0;

6. Char Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "Char Label",
description = "Char Config Example Description",
type = AttributeType.CHARACTER)
char config_char_example() default 0;

7. Byte Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "Byte Label",
description = "Byte Config Example Description",
type = AttributeType.BYTE)
byte config_byte_example() default 0;

See Code Examples!
Click here to view OSGI R6 Configuration Code Examples.

8. Double Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "Double Label",
description = "Double Config Example Description",
type = AttributeType.DOUBLE)
double config_double_example() default 0;

9. Float Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "Float Label",
description = "Float Config Example Description",
type = AttributeType.FLOAT)
float config_float_example() default 0;

10. Boolean Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "Boolean Label",
description = "Boolean Config Example Description",
type = AttributeType.BOOLEAN)
boolean config_boolean_example() default true;

11. Password Attribute Type

1
2
3
4
5

@AttributeDefinition(
name = "Password Label",
description = "Password Config Example Description",
type = AttributeType.PASSWORD)
String config_password_config_example() default "";

12. Options Attribute Type

1
2
3
4
5
6
7
8
9
10
11
12

@AttributeDefinition(
name = "Dropdown Label",
description = "Dropdown Config Example Description",
options = {
@Option(label = "PRODUCTION", value = "PRODUCTION"),
@Option(label = "STAGING", value = "STAGING"),
@Option(label = "UAT", value = "UAT"),
@Option(label = "QA", value = "QA"),
@Option(label = "DEVELOP", value = "DEVELOP")
}
)
String config_dropdown_example() default "DEVELOP";

See Code Examples!
Click here to view OSGI R6 Configuration Code Examples.

The post OSGI R6 Configuration @AttributeDefinition Essentials Reference Guide appeared first on Sourced Code.